diff --git a/.rubocop.yml b/.rubocop.yml index 850865c6..ed582b38 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -1,14 +1,15 @@ -inherit_from: .rubocop_todo.yml +AllCops: + DisabledByDefault: true Style/HashSyntax: Enabled: true - EnforcedStyle: 'hash_rockets' + EnforcedStyle: 'ruby19' -Style/ClassAndModuleChildren: - Enabled: false +Style/FrozenStringLiteralComment: + EnforcedStyle: always_true -Style/Documentation: - Enabled: false +Style/RedundantFreeze: + Enabled: true -Naming/ConstantName: - Enabled: false +Style/StringLiterals: + EnforcedStyle: single_quotes diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml deleted file mode 100644 index 4519791c..00000000 --- a/.rubocop_todo.yml +++ /dev/null @@ -1,442 +0,0 @@ -# This configuration was generated by -# `rubocop --auto-gen-config` -# on 2019-03-25 19:43:51 +0100 using RuboCop version 0.66.0. -# The point is for the user to remove these configuration records -# one by one as the offenses are removed from the code base. -# Note that changes in the inspected code, or installation of new -# versions of RuboCop, may require this file to be generated again. - -# Offense count: 3 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle, IndentOneStep, IndentationWidth. -# SupportedStyles: case, end -Layout/CaseIndentation: - Exclude: - - 'lib/dropbox_api/metadata/member.rb' - -# Offense count: 2 -# Cop supports --auto-correct. -Layout/EmptyLineAfterGuardClause: - Exclude: - - 'lib/dropbox_api/metadata/field.rb' - - 'yardoc/rspec.rb' - -# Offense count: 2 -# Cop supports --auto-correct. -Layout/EmptyLineAfterMagicComment: - Exclude: - - 'dropbox_api.gemspec' - - 'spec/endpoints/files/upload_session_append_v2_spec.rb' - -# Offense count: 2 -# Cop supports --auto-correct. -Layout/EmptyLinesAroundArguments: - Exclude: - - 'spec/endpoints/files/upload_spec.rb' - - 'spec/endpoints/sharing/add_folder_member_spec.rb' - -# Offense count: 3 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle. -# SupportedStyles: empty_lines, no_empty_lines -Layout/EmptyLinesAroundBlockBody: - Exclude: - - 'spec/endpoints/files/upload_spec.rb' - - 'spec/endpoints/sharing/add_folder_member_spec.rb' - - 'spec/metadata/file_spec.rb' - -# Offense count: 1 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle. -# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only -Layout/EmptyLinesAroundClassBody: - Exclude: - - 'lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb' - -# Offense count: 1 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyleAlignWith, AutoCorrect, Severity. -# SupportedStylesAlignWith: keyword, variable, start_of_line -Layout/EndAlignment: - Exclude: - - 'lib/dropbox_api/metadata/member.rb' - -# Offense count: 36 -# Cop supports --auto-correct. -# Configuration parameters: IndentationWidth. -# SupportedStyles: special_inside_parentheses, consistent, align_brackets -Layout/IndentArray: - EnforcedStyle: consistent - -# Offense count: 1 -# Cop supports --auto-correct. -# Configuration parameters: IndentationWidth. -Layout/IndentAssignment: - Exclude: - - 'spec/support/vcr.rb' - -# Offense count: 96 -# Cop supports --auto-correct. -# Configuration parameters: IndentationWidth. -# SupportedStyles: special_inside_parentheses, consistent, align_braces -Layout/IndentHash: - EnforcedStyle: consistent - -# Offense count: 2 -# Cop supports --auto-correct. -Layout/LeadingCommentSpace: - Exclude: - - 'spec/endpoints/auth/token_revoke_spec.rb' - - 'spec/endpoints/files/upload_session_append_v2_spec.rb' - -# Offense count: 6 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle, IndentationWidth. -# SupportedStyles: aligned, indented, indented_relative_to_receiver -Layout/MultilineMethodCallIndentation: - Exclude: - - 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb' - -# Offense count: 2 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters. -# SupportedStyles: space, no_space -# SupportedStylesForEmptyBraces: space, no_space -Layout/SpaceInsideBlockBraces: - Exclude: - - 'yardoc/endpoint_handler.rb' - -# Offense count: 22 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces. -# SupportedStyles: space, no_space, compact -# SupportedStylesForEmptyBraces: space, no_space -Layout/SpaceInsideHashLiteralBraces: - Exclude: - - 'lib/dropbox_api/endpoints/files/download.rb' - - 'lib/dropbox_api/endpoints/files/get_preview.rb' - - 'lib/dropbox_api/endpoints/files/get_temporary_link.rb' - - 'lib/dropbox_api/metadata/shared_link.rb' - - 'spec/metadata/shared_link_spec.rb' - - 'spec/metadata/write_mode_spec.rb' - - 'yardoc/rspec.rb' - -# Offense count: 7 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle. -# SupportedStyles: final_newline, final_blank_line -Layout/TrailingBlankLines: - Exclude: - - 'lib/dropbox_api/endpoints/files/copy_batch_check.rb' - - 'lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb' - - 'lib/dropbox_api/errors/relocation_batch_entry_error.rb' - - 'lib/dropbox_api/errors/revoke_shared_link_error.rb' - - 'lib/dropbox_api/results/copy_batch_check_result.rb' - - 'lib/dropbox_api/results/copy_batch_result.rb' - - 'spec/endpoints/files/copy_batch_check_spec.rb' - -# Offense count: 9 -# Cop supports --auto-correct. -# Configuration parameters: AllowInHeredoc. -Layout/TrailingWhitespace: - Exclude: - - 'lib/dropbox_api/endpoints/files/copy_batch_check.rb' - - 'lib/dropbox_api/endpoints/files/list_folder.rb' - - 'lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb' - - 'lib/dropbox_api/metadata/media_metadata.rb' - - 'lib/dropbox_api/metadata/member_permission.rb' - -# Offense count: 1 -Lint/AmbiguousBlockAssociation: - Exclude: - - 'spec/endpoints/files/upload_spec.rb' - -# Offense count: 3 -Lint/AmbiguousOperator: - Exclude: - - 'spec/endpoints/sharing/list_shared_links_spec.rb' - -# Offense count: 1 -Lint/HandleExceptions: - Exclude: - - 'yardoc/rspec.rb' - -# Offense count: 2 -# Cop supports --auto-correct. -# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments. -Lint/UnusedBlockArgument: - Exclude: - - 'lib/dropbox_api/metadata/base.rb' - - 'spec/support/rake_tasks.rb' - -# Offense count: 1 -# Cop supports --auto-correct. -# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods. -Lint/UnusedMethodArgument: - Exclude: - - 'yardoc/helpers/html_helper.rb' - -# Offense count: 13 -Lint/UselessAssignment: - Exclude: - - 'spec/endpoints/auth/token_revoke_spec.rb' - - 'spec/endpoints/files/download_spec.rb' - - 'spec/endpoints/files/restore_spec.rb' - - 'spec/endpoints/files/save_url_spec.rb' - - 'spec/endpoints/sharing/add_folder_member_spec.rb' - - 'spec/endpoints/sharing/revoke_shared_link_spec.rb' - - 'spec/endpoints/sharing/unshare_file_spec.rb' - - 'spec/metadata/shared_link_spec.rb' - - 'spec/support/vcr.rb' - -# Offense count: 5 -Metrics/AbcSize: - Max: 45 - -# Offense count: 24 -# Configuration parameters: CountComments, ExcludedMethods. -# ExcludedMethods: refine -Metrics/BlockLength: - Max: 130 - -# Offense count: 2 -Metrics/CyclomaticComplexity: - Max: 10 - -# Offense count: 8 -# Configuration parameters: CountComments, ExcludedMethods. -Metrics/MethodLength: - Max: 25 - -# Offense count: 2 -Metrics/PerceivedComplexity: - Max: 10 - -# Offense count: 1 -# Configuration parameters: EnforcedStyleForLeadingUnderscores. -# SupportedStylesForLeadingUnderscores: disallowed, required, optional -Naming/MemoizedInstanceVariableName: - Exclude: - - 'lib/dropbox_api/results/list_shared_links_result.rb' - -# Offense count: 5 -# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros. -# NamePrefix: is_, has_, have_ -# NamePrefixBlacklist: is_, has_, have_ -# NameWhitelist: is_a? -# MethodDefinitionMacros: define_method, define_singleton_method -Naming/PredicateName: - Exclude: - - 'spec/**/*' - - 'lib/dropbox_api/result_builder.rb' - - 'lib/dropbox_api/results/list_folder_result.rb' - - 'lib/dropbox_api/results/list_revisions_result.rb' - - 'lib/dropbox_api/results/list_shared_links_result.rb' - - 'lib/dropbox_api/results/search_result.rb' - -# Offense count: 1 -# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames. -# AllowedNames: io, id, to, by, on, in, at, ip, db -Naming/UncommunicativeMethodParamName: - Exclude: - - 'lib/dropbox_api/metadata/upload_session_cursor.rb' - -# Offense count: 2 -# Cop supports --auto-correct. -# Configuration parameters: AutoCorrect. -Performance/TimesMap: - Exclude: - - 'spec/endpoints/files/upload_spec.rb' - -# Offense count: 53 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods, AllowBracesOnProceduralOneLiners. -# SupportedStyles: line_count_based, semantic, braces_for_chaining -# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object -# FunctionalMethods: let, let!, subject, watch -# IgnoredMethods: lambda, proc, it -Style/BlockDelimiters: - Enabled: false - -# Offense count: 58 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle. -# SupportedStyles: braces, no_braces, context_dependent -Style/BracesAroundHashParameters: - Enabled: false - -# Offense count: 1 -Style/CaseEquality: - Exclude: - - 'lib/dropbox_api/results/copy_batch_check_result.rb' - -# Offense count: 1 -# Cop supports --auto-correct. -# Configuration parameters: Keywords. -# Keywords: TODO, FIXME, OPTIMIZE, HACK, REVIEW -Style/CommentAnnotation: - Exclude: - - 'lib/dropbox_api/endpoints/content_download.rb' - -# Offense count: 1 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle. -# SupportedStyles: compact, expanded -Style/EmptyMethod: - Exclude: - - 'lib/dropbox_api/metadata/shared_link.rb' - -# Offense count: 2 -# Cop supports --auto-correct. -Style/Encoding: - Exclude: - - 'dropbox_api.gemspec' - - 'spec/endpoints/files/upload_session_append_v2_spec.rb' - -# Offense count: 5 -# Cop supports --auto-correct. -Style/ExpandPathArguments: - Exclude: - - 'Rakefile' - - 'dropbox_api.gemspec' - - 'spec/spec_helper.rb' - - 'spec/support/dropbox_scaffold_builder.rb' - - 'spec/support/rake_tasks.rb' - -# Offense count: 3 -# Configuration parameters: MinBodyLength. -Style/GuardClause: - Exclude: - - 'lib/dropbox_api/endpoints/base.rb' - - 'lib/dropbox_api/metadata/tag.rb' - - 'lib/dropbox_api/metadata/write_mode.rb' - -# Offense count: 8 -# Cop supports --auto-correct. -Style/IfUnlessModifier: - Exclude: - - 'lib/dropbox_api/metadata/shared_link.rb' - - 'lib/dropbox_api/metadata/write_mode.rb' - - 'lib/dropbox_api/options_validator.rb' - - 'yardoc/endpoint_handler.rb' - -# Offense count: 1 -# Cop supports --auto-correct. -# Configuration parameters: InverseMethods, InverseBlocks. -Style/InverseMethods: - Exclude: - - 'lib/dropbox_api/metadata/base.rb' - -# Offense count: 1 -Style/MultilineBlockChain: - Exclude: - - 'lib/dropbox_api/metadata/base.rb' - -# Offense count: 8 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle. -# SupportedStyles: literals, strict -Style/MutableConstant: - Exclude: - - 'lib/dropbox_api/errors/too_many_requests_error.rb' - - 'lib/dropbox_api/errors/write_conflict_error.rb' - - 'lib/dropbox_api/errors/write_error.rb' - - 'lib/dropbox_api/metadata/access_level.rb' - - 'lib/dropbox_api/metadata/member_action.rb' - - 'lib/dropbox_api/metadata/shared_link.rb' - - 'lib/dropbox_api/metadata/write_mode.rb' - - 'spec/support/dropbox_scaffold_builder.rb' - -# Offense count: 4 -# Cop supports --auto-correct. -# Configuration parameters: Whitelist. -# Whitelist: be, be_a, be_an, be_between, be_falsey, be_kind_of, be_instance_of, be_truthy, be_within, eq, eql, end_with, include, match, raise_error, respond_to, start_with -Style/NestedParenthesizedCalls: - Exclude: - - 'spec/endpoints/content_upload_spec.rb' - - 'spec/endpoints/sharing/list_shared_links_spec.rb' - -# Offense count: 10 -# Cop supports --auto-correct. -# Configuration parameters: Strict. -Style/NumericLiterals: - MinDigits: 11 - -# Offense count: 1 -# Cop supports --auto-correct. -Style/ParallelAssignment: - Exclude: - - 'lib/dropbox_api/middleware/stack.rb' - -# Offense count: 7 -# Cop supports --auto-correct. -# Configuration parameters: PreferredDelimiters. -Style/PercentLiteralDelimiters: - Exclude: - - 'spec/endpoints/sharing/add_file_member_spec.rb' - - 'spec/endpoints/sharing/list_shared_links_spec.rb' - - 'spec/endpoints/users/get_account_batch_spec.rb' - - 'spec/metadata/file_spec.rb' - - 'spec/metadata/member_action_list_spec.rb' - -# Offense count: 3 -# Cop supports --auto-correct. -# Configuration parameters: AllowMultipleReturnValues. -Style/RedundantReturn: - Exclude: - - 'lib/dropbox_api/endpoints/content_download.rb' - - 'lib/dropbox_api/endpoints/content_upload.rb' - - 'lib/dropbox_api/endpoints/rpc.rb' - -# Offense count: 887 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline. -# SupportedStyles: single_quotes, double_quotes -Style/StringLiterals: - Enabled: false - -# Offense count: 6 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyle. -# SupportedStyles: single_quotes, double_quotes -Style/StringLiteralsInInterpolation: - Exclude: - - 'lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb' - - 'lib/dropbox_api/metadata/write_mode.rb' - - 'lib/dropbox_api/results/copy_batch_check_result.rb' - - 'lib/dropbox_api/results/save_url_job_status.rb' - -# Offense count: 24 -# Cop supports --auto-correct. -# Configuration parameters: MinSize. -# SupportedStyles: percent, brackets -Style/SymbolArray: - EnforcedStyle: brackets - -# Offense count: 1 -# Cop supports --auto-correct. -# Configuration parameters: EnforcedStyleForMultiline. -# SupportedStylesForMultiline: comma, consistent_comma, no_comma -Style/TrailingCommaInHashLiteral: - Exclude: - - 'lib/dropbox_api/errors/share_path_error.rb' - -# Offense count: 1 -# Cop supports --auto-correct. -# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist. -# Whitelist: to_ary, to_a, to_c, to_enum, to_h, to_hash, to_i, to_int, to_io, to_open, to_path, to_proc, to_r, to_regexp, to_str, to_s, to_sym -Style/TrivialAccessors: - Exclude: - - 'lib/dropbox_api/middleware/stack.rb' - -# Offense count: 1 -# Cop supports --auto-correct. -Style/UnneededInterpolation: - Exclude: - - 'lib/dropbox_api/results/copy_batch_check_result.rb' - -# Offense count: 147 -# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns. -# URISchemes: http, https -Metrics/LineLength: - Max: 190 diff --git a/CHANGES.md b/CHANGES.md deleted file mode 100644 index c794aed4..00000000 --- a/CHANGES.md +++ /dev/null @@ -1,7 +0,0 @@ -This file aims to compile all the breaking changes introduced in each version. - -### Version 0.2 - -- `list_folder_members` changed its signature from - `list_folder_members(folder_id, options = {})` to - `list_folder_members(folder_id, actions = [], options = {})` diff --git a/Gemfile b/Gemfile index c2e24d64..7318676b 100644 --- a/Gemfile +++ b/Gemfile @@ -1,13 +1,34 @@ +# frozen_string_literal: true source 'https://rubygems.org' gemspec group :development do + gem 'bundler', '>= 1.7' + gem 'rake' + + # Test + gem 'rspec' + gem 'vcr' + gem 'webmock' + + # Gem dependencies + if RUBY_VERSION >= '2.6' + gem 'faraday', '~> 2.0' + gem 'faraday-net_http_persistent' + else + gem 'faraday', '~> 1.0' + end + + # Documentation gem 'redcarpet' - gem 'yard-tests-rspec', :git => "https://github.com/Jesus/yard-spec-plugin.git" + gem 'yard-tests-rspec', git: 'https://github.com/Jesus/yard-spec-plugin.git' + + # Debugging + gem 'byebug' # Code linting - gem 'rubocop', :require => false - gem 'rubocop-rspec', :require => false + gem 'rubocop', require: false + gem 'rubocop-rspec', require: false end diff --git a/README.md b/README.md index d477109c..5908b855 100644 --- a/README.md +++ b/README.md @@ -56,44 +56,115 @@ DropboxApi::Client.new #=> # ``` -Note that setting an ENV variable is only a feasible choice if you're only -using one account. +The official documentation on the process to get an authorization code is +[here](https://developers.dropbox.com/es-es/oauth-guide#implementing-oauth), +it describes the two options listed below. -#### Option A: Get your access token from the website -The easiest way to obtain an access token is to get it from the Dropbox website. -You just need to log in to Dropbox and refer to the *developers* section, go to -*My apps* and select your application, you may need to create one if you -haven't done so yet. +#### Option A: Get your access token from the website -Under your application settings, find section *OAuth 2*. You'll find a button -to generate an access token. +For a quick test, you can obtain an access token from the App Console in +[Dropbox's website](https://www.dropbox.com/developers/). Select from +*My apps* your application, you may need to create one if you +haven't done so yet. Under your application settings, find section +*OAuth 2*, there is a button to generate an access token. -#### Option B: Use `DropboxApi::Authenticator` +#### Option B: OAuth2 Code Flow -You can obtain an authorization code with this library: +This is typically what you will use in production, you can obtain an +authorization code with a 3-step process: ```ruby +# 1. Get an authorization URL. authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET) -authenticator.authorize_url #=> "https://www.dropbox.com/..." +authenticator.auth_code.authorize_url #=> "https://www.dropbox.com/..." -# Now you need to open the authorization URL in your browser, -# authorize the application and copy your code. +# 2. Log into Dropbox and authorize your app. You need to open the +# authorization URL in your browser. -auth_bearer = authenticator.get_token(CODE) #=> #` -auth_bearer.token #=> "VofXAX8D..." -# Keep this token, you'll need it to initialize a `DropboxApi::Client` object -``` +# 3. Exchange the authorization code for a reusable access token (not visible +# to the user). +access_token = authenticator.auth_code.get_token(CODE) #=> #` +access_token.token #=> "VofXAX8D..." -#### Standard OAuth 2 flow +# Keep this token, you'll need it to initialize a `DropboxApi::Client` object: +client = DropboxApi::Client.new(access_token: access_token) + +# For backwards compatibility, the following also works: +client = DropboxApi::Client.new(access_token.token) +``` -This is what many web applications will use. The process is described in -Dropbox's [OAuth guide] -(https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web). +##### Integration with Rails If you have a Rails application, you might be interested in this [setup guide](http://jesus.github.io/dropbox_api/file.rails_setup.html). + +##### Using refresh tokens + +Access tokens are short-lived by default (as of September 30th, 2021), +applications that require long-lived access to the API without additional +interaction with the user should use refresh tokens. + +The process is similar but a token refresh might seamlessly occur as you +perform API calls. When this happens you'll need to store the +new token hash if you want to continue using this session, you can use the +`on_token_refreshed` callback to do this. + +```ruby +# 1. Get an authorization URL, requesting offline access type. +authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET) +authenticator.auth_code.authorize_url(token_access_type: 'offline') + +# 2. Log into Dropbox and authorize your app. You need to open the +# authorization URL in your browser. + +# 3. Exchange the authorization code for a reusable access token +access_token = authenticator.auth_code.get_token(CODE) #=> #` + +# You can now use the access token to initialize a DropboxApi::Client, you +# should also provide a callback function to store the updated access token +# whenever it's refreshed. +client = DropboxApi::Client.new( + access_token: access_token, + on_token_refreshed: lambda { |new_token_hash| + # token_hash is a serializable Hash, something like this: + # { + # "uid"=>"440", + # "token_type"=>"bearer", + # "scope"=>"account_info.read account_info.write...", + # "account_id"=>"dbid:AABOLtA1rT6rRK4vajKZ...", + # :access_token=>"sl.A5Ez_CBsqJILhDawHlmXSoZEhLZ4nuLFVRs6AJ...", + # :refresh_token=>"iMg4Me_oKYUAAAAAAAAAAapQixCgwfXOxuubCuK_...", + # :expires_at=>1632948328 + # } + SomewhereSafe.save(new_token_hash) + } +) +``` + +Once you've gone through the process above, you can skip the steps that require +user interaction in subsequent initializations of `DropboxApi::Client`. For +example: + +```ruby +# 1. Initialize an authenticator +authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET) + +# 2. Retrieve the token hash you previously stored somewhere safe, you can use +# it to build a new access token. +access_token = OAuth2::AccessToken.from_hash(authenticator, token_hash) + +# 3. You now have an access token, so you can initialize a client like you +# would normally: +client = DropboxApi::Client.new( + access_token: access_token, + on_token_refreshed: lambda { |new_token_hash| + SomewhereSafe.save(new_token_hash) + } +) +``` + ### Performing API calls Once you've initialized a client, for example: @@ -139,6 +210,26 @@ Check out the [method documentation](http://www.xuuso.com/dropbox_api/DropboxApi/Client.html#upload_by_chunks-instance_method) to find out all available options. +### Accessing Team Folders + +In order to access your team scope you need to add the namespace_id to you request headers. +This can be done using the middlewere layer as per the below: + +```ruby +client = DropboxApi::Client.new("VofXAX8D...") +#=> # +client.namespace_id = client.get_current_account.root_info.root_namespace_id + +client.list_folder('') +#=> Now returns the team folders +``` + +You could unset the namespace ID at any point afterwards with just: + +```ruby +client.namespace_id = nil +``` + ## Dependencies This gem depends on @@ -172,6 +263,11 @@ would be the procedure to do so: DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rake test:build_scaffold[list_folder] ``` + Note that you'll have to type `rake test:build_scaffold\[list_folder\]` + if you use `zsh`. + + You can build all available scaffolds with just `rake test:build_scaffold`. + 3. Run the tests and the cassettes will be written: ```text @@ -182,7 +278,7 @@ The OAuth bearer shouldn't have been recorded in the cassette and it should've been filtered. However, you may want to double check before pushing your updates to Github. -Tip: You can simply run `export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER` at +Tip: you can simply run `export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER` at the beginning of your work session so you don't need to prefix it in every command line. diff --git a/Rakefile b/Rakefile index b7ea731f..5a5edebe 100644 --- a/Rakefile +++ b/Rakefile @@ -1,7 +1,8 @@ -require "bundler/gem_tasks" -require "rspec/core/rake_task" +# frozen_string_literal: true +require 'bundler/gem_tasks' +require 'rspec/core/rake_task' require File.expand_path('../spec/support/rake_tasks', __FILE__) RSpec::Core::RakeTask.new(:spec) -task :default => :spec +task default: :spec diff --git a/api_coverage.md b/api_coverage.md index 51bcf803..018d3c71 100644 --- a/api_coverage.md +++ b/api_coverage.md @@ -68,7 +68,7 @@ API call | Status `/restore` | 🌕 `/save_url` | 🌕 `/save_url/check_job_status` | 🌕 -`/search` | 🌔 +`/search_v2` | 🌔 `/upload` | 🌕 `/upload_session/append` | alias? `/upload_session/append_v2` | 🌕 diff --git a/bin/console b/bin/console index 714cb91c..40ba0a43 100755 --- a/bin/console +++ b/bin/console @@ -1,7 +1,8 @@ #!/usr/bin/env ruby +# frozen_string_literal: true -require "bundler/setup" -require "dropbox_api" +require 'bundler/setup' +require 'dropbox_api' # You can add fixtures and/or initialization code here to make experimenting # with your gem easier. You can also use a different console, if you like. @@ -10,5 +11,5 @@ require "dropbox_api" # require "pry" # Pry.start -require "irb" +require 'irb' IRB.start diff --git a/doc/DropboxApi.html b/doc/DropboxApi.html new file mode 100644 index 00000000..15c3b862 --- /dev/null +++ b/doc/DropboxApi.html @@ -0,0 +1,123 @@ + + + + + + +module DropboxApi - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
MiddlewareEnd + +
+ + +
MiddlewareMiddle + +
+ + +
MiddlewareStart + +

Mock middleware

+ + +
VERSION + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Authenticator.html b/doc/DropboxApi/Authenticator.html new file mode 100644 index 00000000..914a6601 --- /dev/null +++ b/doc/DropboxApi/Authenticator.html @@ -0,0 +1,160 @@ + + + + + + +class DropboxApi::Authenticator - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Authenticator +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(client_id, client_secret) + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + +
+ + + +
+
# File lib/dropbox_api/authenticator.rb, line 5
+def initialize(client_id, client_secret)
+  super(client_id, client_secret, {
+    authorize_url: 'https://www.dropbox.com/oauth2/authorize',
+    token_url: 'https://api.dropboxapi.com/oauth2/token'
+  })
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/ChunkedUploader.html b/doc/DropboxApi/ChunkedUploader.html new file mode 100644 index 00000000..cfec69ee --- /dev/null +++ b/doc/DropboxApi/ChunkedUploader.html @@ -0,0 +1,290 @@ + + + + + + +class DropboxApi::ChunkedUploader - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::ChunkedUploader +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(client, path, i_stream, options = {}) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/chunked_uploader.rb, line 5
+def initialize(client, path, i_stream, options = {})
+  @chunk_size = options.delete(:chunk_size) || 4 * 1024 * 1024 # 4 MiB
+
+  @client = client
+  @i_stream = i_stream
+
+  init_commit_info(path, options)
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ finish() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/chunked_uploader.rb, line 31
+def finish
+  @client.upload_session_finish @cursor, @commit_info
+end
+
+ +
+ + + + +
+ + +
+ +
+ start() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/chunked_uploader.rb, line 14
+def start
+  chunk = @i_stream.read @chunk_size
+  chunk = '' if chunk.nil?
+
+  @cursor = @client.upload_session_start chunk
+end
+
+ +
+ + + + +
+ + +
+ +
+ upload() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/chunked_uploader.rb, line 21
+def upload
+  loop do
+    chunk = @i_stream.read @chunk_size
+    break if chunk.nil?
+
+    @client.upload_session_append_v2 @cursor, chunk
+    break if chunk.size < @chunk_size
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Client.html b/doc/DropboxApi/Client.html new file mode 100644 index 00000000..2b9b9a8a --- /dev/null +++ b/doc/DropboxApi/Client.html @@ -0,0 +1,410 @@ + + + + + + +class DropboxApi::Client - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Client +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ add_endpoint(name, endpoint) + + click to toggle source + +
+ + +
+ +

@!visibility private

+ + + + +
+
# File lib/dropbox_api/client.rb, line 33
+def self.add_endpoint(name, endpoint)
+  define_method(name) do |*args, &block|
+    endpoint.new(@connection_builder).send(name, *args, &block)
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ new( oauth_bearer = ENV['DROPBOX_OAUTH_BEARER'], access_token: nil, on_token_refreshed: nil ) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/client.rb, line 3
+def initialize(
+  oauth_bearer = ENV['DROPBOX_OAUTH_BEARER'],
+  access_token: nil,
+  on_token_refreshed: nil
+)
+  if access_token
+    @connection_builder = ConnectionBuilder.new(
+      access_token: access_token,
+      on_token_refreshed: on_token_refreshed
+    )
+  elsif oauth_bearer
+    @connection_builder = ConnectionBuilder.new(oauth_bearer)
+  else
+    raise ArgumentError, "Either oauth_bearer or access_token should be set"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ middleware() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/client.rb, line 20
+def middleware
+  @connection_builder.middleware
+end
+
+ +
+ + + + +
+ + +
+ +
+ namespace_id() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/client.rb, line 28
+def namespace_id
+  @connection_builder.namespace_id
+end
+
+ +
+ + + + +
+ + +
+ +
+ namespace_id=(value) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/client.rb, line 24
+def namespace_id=(value)
+  @connection_builder.namespace_id = value
+end
+
+ +
+ + + + +
+ + +
+ +
+ upload_by_chunks(path, content, options = {}) + + click to toggle source + +
+ + +
+ +

Creates a new file using the *upload session* endpoints. You can use this +method to upload files larger than 150 MB.

+ +

@example

+ +
client = DropboxApi::Client.new
+File.open "large file.avi" do |file|
+  client.upload "/large file.avi", file
+  #=> #<DropboxApi::Metadata::File: @name="large file.avi" ...>
+end
+
+ +

@example

+ +
client = DropboxApi::Client.new
+client.upload "/file.txt", "File contents...", :mode => :add
+#=> #<DropboxApi::Metadata::File: @name="file (1).txt" ...>
+
+ +

@param path [String] Path in the user's Dropbox to save the file. +@param content The contents of the file that will be uploaded. This

+ +
could be the result of the `IO::read` method.
+ +

@option options mode [DropboxApi::Metadata::WriteMode] Selects what to

+ +
do if the file already exists. The default is `add`.
+ +

@option options autorename [Boolean] If there's a conflict, as +determined

+ +
by `mode`, have the Dropbox server try to autorename the file to avoid
+conflict. The default for this field is `false`.
+ +

@option options client_modified [DateTime] The value to store as the

+ +
`client_modified` timestamp. Dropbox automatically records the time at
+which the file was written to the Dropbox servers. It can also record
+an additional timestamp, provided by Dropbox desktop clients, mobile
+clients, and API apps of when the file was actually created or
+modified.
+ +

@option options mute [Boolean] Normally, users are made aware of any

+ +
file modifications in their Dropbox account via notifications in the
+client software. If `true`, this tells the clients that this
+modification shouldn't result in a user notification. The default for
+this field is `false`.
+ +

@option options chunk_size [Numeric] The size of each upload chunk. It

+ +
defaults to 4 MiB.
+ +

@see DropboxApi::Metadata::WriteMode

+ +

@!group virtual

+ + + + +
+
# File lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb, line 40
+def upload_by_chunks(path, content, options = {})
+  content = StringIO.new(content) if content.is_a?(String)
+
+  uploader = DropboxApi::ChunkedUploader.new(self, path, content, options)
+  uploader.start
+  uploader.upload
+  uploader.finish
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/ConnectionBuilder.html b/doc/DropboxApi/ConnectionBuilder.html new file mode 100644 index 00000000..7f3b352a --- /dev/null +++ b/doc/DropboxApi/ConnectionBuilder.html @@ -0,0 +1,341 @@ + + + + + + +class DropboxApi::ConnectionBuilder - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::ConnectionBuilder +

+ +
+ +
+ + +
+ + + + + + + +
+
+

Attributes

+
+ + +
+
+ namespace_id[RW] +
+ +
+ + + +
+
+ +
+ + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(oauth_bearer = nil, access_token: nil, on_token_refreshed: nil) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/connection_builder.rb, line 5
+def initialize(oauth_bearer = nil, access_token: nil, on_token_refreshed: nil)
+  if access_token
+    if !access_token.is_a?(OAuth2::AccessToken)
+      raise ArgumentError, "access_token should be an OAuth2::AccessToken"
+    end
+
+    @access_token = access_token
+    @on_token_refreshed = on_token_refreshed
+  elsif oauth_bearer
+    @oauth_bearer = oauth_bearer
+  else
+    raise ArgumentError, "Either oauth_bearer or access_token should be set"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ build(url) { |connection| ... } + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/connection_builder.rb, line 43
+def build(url)
+  Faraday.new(url) do |connection|
+    connection.use DropboxApi::MiddleWare::PathRoot, {
+      namespace_id: self.namespace_id
+    }
+    middleware.apply(connection) do
+      connection.request :authorization, :Bearer, bearer
+      yield connection
+    end
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ can_refresh_access_token?() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/connection_builder.rb, line 24
+def can_refresh_access_token?
+  @access_token && @access_token.refresh_token
+end
+
+ +
+ + + + +
+ + +
+ +
+ middleware() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/connection_builder.rb, line 20
+def middleware
+  @middleware ||= MiddleWare::Stack.new
+end
+
+ +
+ + + + +
+ + +
+ +
+ refresh_access_token() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/connection_builder.rb, line 28
+def refresh_access_token
+  @access_token = @access_token.refresh!
+  @on_token_refreshed.call(@access_token.to_hash) if @on_token_refreshed
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints.html b/doc/DropboxApi/Endpoints.html new file mode 100644 index 00000000..7a410d46 --- /dev/null +++ b/doc/DropboxApi/Endpoints.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::Endpoints - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::Endpoints +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Auth.html b/doc/DropboxApi/Endpoints/Auth.html new file mode 100644 index 00000000..d1170256 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Auth.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::Endpoints::Auth - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::Endpoints::Auth +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Auth/TokenRevoke.html b/doc/DropboxApi/Endpoints/Auth/TokenRevoke.html new file mode 100644 index 00000000..d612e588 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Auth/TokenRevoke.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Auth::TokenRevoke - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Auth::TokenRevoke +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Base.html b/doc/DropboxApi/Endpoints/Base.html new file mode 100644 index 00000000..b4e265fe --- /dev/null +++ b/doc/DropboxApi/Endpoints/Base.html @@ -0,0 +1,189 @@ + + + + + + +class DropboxApi::Endpoints::Base - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Base +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ add_endpoint(name, &block) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/base.rb, line 8
+def self.add_endpoint(name, &block)
+  define_method(name, block)
+  DropboxApi::Client.add_endpoint(name, self)
+end
+
+ +
+ + + + +
+ + +
+ +
+ new(builder) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/base.rb, line 3
+def initialize(builder)
+  @builder = builder
+  build_connection
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/ContentDownload.html b/doc/DropboxApi/Endpoints/ContentDownload.html new file mode 100644 index 00000000..5ed1fa68 --- /dev/null +++ b/doc/DropboxApi/Endpoints/ContentDownload.html @@ -0,0 +1,237 @@ + + + + + + +class DropboxApi::Endpoints::ContentDownload - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::ContentDownload +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ build_connection() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/content_download.rb, line 3
+def build_connection
+  @connection = @builder.build('https://content.dropboxapi.com') do |c|
+    c.response :decode_result
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ build_request(params) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/content_download.rb, line 9
+def build_request(params)
+  body = nil
+  headers = {
+    'Dropbox-API-Arg' => JSON.dump(params),
+    'Content-Type' => ''
+  }
+
+  return body, headers
+end
+
+ +
+ + + + +
+ + +
+ +
+ perform_request(params) { |body| ... } + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/content_download.rb, line 19
+def perform_request(params)
+  response = get_response(params)
+  api_result = process_response response
+
+  # We just yield the whole response to the block, it'd be nice in the
+  # future to support an interface that streams the response in chunks.
+  yield response.body if block_given?
+
+  api_result
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/ContentUpload.html b/doc/DropboxApi/Endpoints/ContentUpload.html new file mode 100644 index 00000000..e11cb006 --- /dev/null +++ b/doc/DropboxApi/Endpoints/ContentUpload.html @@ -0,0 +1,232 @@ + + + + + + +class DropboxApi::Endpoints::ContentUpload - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::ContentUpload +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ build_connection() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/content_upload.rb, line 3
+def build_connection
+  @connection = @builder.build('https://content.dropboxapi.com') do |c|
+    c.response :decode_result
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ build_request(params, body) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/content_upload.rb, line 9
+def build_request(params, body)
+  headers = {
+    'Dropbox-API-Arg' => JSON.dump(params),
+    'Content-Type' => 'application/octet-stream'
+  }
+
+  content_length = get_content_length body
+  headers['Content-Length'] = content_length unless content_length.nil?
+
+  return body, headers
+end
+
+ +
+ + + + +
+ + +
+ +
+ perform_request(params, content) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/content_upload.rb, line 21
+def perform_request(params, content)
+  process_response(get_response(params, content))
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files.html b/doc/DropboxApi/Endpoints/Files.html new file mode 100644 index 00000000..5e1c3fcd --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::Endpoints::Files - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::Endpoints::Files +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/Copy.html b/doc/DropboxApi/Endpoints/Files/Copy.html new file mode 100644 index 00000000..5d0ca900 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/Copy.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::Copy - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::Copy +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/CopyBatch.html b/doc/DropboxApi/Endpoints/Files/CopyBatch.html new file mode 100644 index 00000000..aa59e8f3 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/CopyBatch.html @@ -0,0 +1,136 @@ + + + + + + +class DropboxApi::Endpoints::Files::CopyBatch - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::CopyBatch +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/CopyBatchCheck.html b/doc/DropboxApi/Endpoints/Files/CopyBatchCheck.html new file mode 100644 index 00000000..067f35cf --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/CopyBatchCheck.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::CopyBatchCheck - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::CopyBatchCheck +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/CopyReferenceGet.html b/doc/DropboxApi/Endpoints/Files/CopyReferenceGet.html new file mode 100644 index 00000000..b3b746b3 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/CopyReferenceGet.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::CopyReferenceGet - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::CopyReferenceGet +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/CopyReferenceSave.html b/doc/DropboxApi/Endpoints/Files/CopyReferenceSave.html new file mode 100644 index 00000000..c955e674 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/CopyReferenceSave.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::CopyReferenceSave - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::CopyReferenceSave +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/CreateFileRequest.html b/doc/DropboxApi/Endpoints/Files/CreateFileRequest.html new file mode 100644 index 00000000..640d4a66 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/CreateFileRequest.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::CreateFileRequest - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::CreateFileRequest +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/CreateFolder.html b/doc/DropboxApi/Endpoints/Files/CreateFolder.html new file mode 100644 index 00000000..32007fa7 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/CreateFolder.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::CreateFolder - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::CreateFolder +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/CreateFolderBatch.html b/doc/DropboxApi/Endpoints/Files/CreateFolderBatch.html new file mode 100644 index 00000000..b357eb7c --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/CreateFolderBatch.html @@ -0,0 +1,136 @@ + + + + + + +class DropboxApi::Endpoints::Files::CreateFolderBatch - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::CreateFolderBatch +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html b/doc/DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html new file mode 100644 index 00000000..ef559603 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::CreateFolderBatchCheck - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::CreateFolderBatchCheck +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/Delete.html b/doc/DropboxApi/Endpoints/Files/Delete.html new file mode 100644 index 00000000..1db93b1a --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/Delete.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::Delete - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::Delete +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/DeleteBatch.html b/doc/DropboxApi/Endpoints/Files/DeleteBatch.html new file mode 100644 index 00000000..18c97451 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/DeleteBatch.html @@ -0,0 +1,125 @@ + + + + + + +class DropboxApi::Endpoints::Files::DeleteBatch - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::DeleteBatch +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/DeleteBatchCheck.html b/doc/DropboxApi/Endpoints/Files/DeleteBatchCheck.html new file mode 100644 index 00000000..42e54ec9 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/DeleteBatchCheck.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::DeleteBatchCheck - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::DeleteBatchCheck +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/Download.html b/doc/DropboxApi/Endpoints/Files/Download.html new file mode 100644 index 00000000..8043a685 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/Download.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::Download - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::Download +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/GetMetadata.html b/doc/DropboxApi/Endpoints/Files/GetMetadata.html new file mode 100644 index 00000000..9f2e433f --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/GetMetadata.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::GetMetadata - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::GetMetadata +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/GetPreview.html b/doc/DropboxApi/Endpoints/Files/GetPreview.html new file mode 100644 index 00000000..e5466287 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/GetPreview.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::GetPreview - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::GetPreview +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/GetTemporaryLink.html b/doc/DropboxApi/Endpoints/Files/GetTemporaryLink.html new file mode 100644 index 00000000..c06bc57a --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/GetTemporaryLink.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::GetTemporaryLink - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::GetTemporaryLink +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/GetThumbnail.html b/doc/DropboxApi/Endpoints/Files/GetThumbnail.html new file mode 100644 index 00000000..41eefbba --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/GetThumbnail.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::GetThumbnail - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::GetThumbnail +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/GetThumbnailBatch.html b/doc/DropboxApi/Endpoints/Files/GetThumbnailBatch.html new file mode 100644 index 00000000..2ee66098 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/GetThumbnailBatch.html @@ -0,0 +1,194 @@ + + + + + + +class DropboxApi::Endpoints::Files::GetThumbnailBatch - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::GetThumbnailBatch +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ build_entries_params(paths, options) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb, line 31
+def build_entries_params(paths, options)
+  paths.map do |path|
+    options.merge({ path: path })
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/ListFolder.html b/doc/DropboxApi/Endpoints/Files/ListFolder.html new file mode 100644 index 00000000..789d1c7e --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/ListFolder.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::ListFolder - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::ListFolder +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/ListFolderContinue.html b/doc/DropboxApi/Endpoints/Files/ListFolderContinue.html new file mode 100644 index 00000000..6aa6623f --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/ListFolderContinue.html @@ -0,0 +1,134 @@ + + + + + + +class DropboxApi::Endpoints::Files::ListFolderContinue - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::ListFolderContinue +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +

NOTE: This hasn't been tested with real data, I couldn't make a +query

+ +
long enough to enable the `has_more` attribute in the
+`ListFolderResult`.
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html b/doc/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html new file mode 100644 index 00000000..cafb53bf --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::ListFolderGetLatestCursor - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::ListFolderGetLatestCursor +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/ListFolderLongpoll.html b/doc/DropboxApi/Endpoints/Files/ListFolderLongpoll.html new file mode 100644 index 00000000..05affaa9 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/ListFolderLongpoll.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::ListFolderLongpoll - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::ListFolderLongpoll +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/ListRevisions.html b/doc/DropboxApi/Endpoints/Files/ListRevisions.html new file mode 100644 index 00000000..0d7a30d7 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/ListRevisions.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::ListRevisions - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::ListRevisions +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/Move.html b/doc/DropboxApi/Endpoints/Files/Move.html new file mode 100644 index 00000000..dabc839d --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/Move.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::Move - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::Move +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/PermanentlyDelete.html b/doc/DropboxApi/Endpoints/Files/PermanentlyDelete.html new file mode 100644 index 00000000..2f3ef8cf --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/PermanentlyDelete.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::PermanentlyDelete - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::PermanentlyDelete +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/Restore.html b/doc/DropboxApi/Endpoints/Files/Restore.html new file mode 100644 index 00000000..5456e75f --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/Restore.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::Restore - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::Restore +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/SaveUrl.html b/doc/DropboxApi/Endpoints/Files/SaveUrl.html new file mode 100644 index 00000000..99be4cd2 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/SaveUrl.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::SaveUrl - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::SaveUrl +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html b/doc/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html new file mode 100644 index 00000000..ff06ab2c --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/Search.html b/doc/DropboxApi/Endpoints/Files/Search.html new file mode 100644 index 00000000..3d688026 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/Search.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::Search - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::Search +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/SearchContinue.html b/doc/DropboxApi/Endpoints/Files/SearchContinue.html new file mode 100644 index 00000000..091b3e56 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/SearchContinue.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::SearchContinue - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::SearchContinue +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/Upload.html b/doc/DropboxApi/Endpoints/Files/Upload.html new file mode 100644 index 00000000..bb348bf7 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/Upload.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::Upload - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::Upload +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html b/doc/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html new file mode 100644 index 00000000..cb7e9cb1 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::UploadSessionAppendV2 - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::UploadSessionAppendV2 +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/UploadSessionFinish.html b/doc/DropboxApi/Endpoints/Files/UploadSessionFinish.html new file mode 100644 index 00000000..a3911a96 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/UploadSessionFinish.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::UploadSessionFinish - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::UploadSessionFinish +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Files/UploadSessionStart.html b/doc/DropboxApi/Endpoints/Files/UploadSessionStart.html new file mode 100644 index 00000000..4740f6af --- /dev/null +++ b/doc/DropboxApi/Endpoints/Files/UploadSessionStart.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Files::UploadSessionStart - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Files::UploadSessionStart +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Rpc.html b/doc/DropboxApi/Endpoints/Rpc.html new file mode 100644 index 00000000..05c32b91 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Rpc.html @@ -0,0 +1,233 @@ + + + + + + +class DropboxApi::Endpoints::Rpc - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Rpc +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ build_connection() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/rpc.rb, line 3
+def build_connection
+  @connection = @builder.build('https://api.dropboxapi.com') do |c|
+    c.response :decode_result
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ build_request(params) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/rpc.rb, line 9
+def build_request(params)
+  request_headers = {
+    'content-type' => 'application/json'
+  }
+
+  return request_body(params), request_headers
+end
+
+ +
+ + + + +
+ + +
+ +
+ request_body(params) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/rpc.rb, line 17
+def request_body(params)
+  # This check is only required for compatibility with old JSON serializers
+  if params.nil?
+    'null'
+  else
+    JSON.dump(params)
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/RpcContent.html b/doc/DropboxApi/Endpoints/RpcContent.html new file mode 100644 index 00000000..7f075852 --- /dev/null +++ b/doc/DropboxApi/Endpoints/RpcContent.html @@ -0,0 +1,154 @@ + + + + + + +class DropboxApi::Endpoints::RpcContent - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::RpcContent +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ build_connection() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/rpc_content.rb, line 3
+def build_connection
+  @connection = @builder.build('https://content.dropboxapi.com') do |c|
+    c.response :decode_result
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/RpcNotify.html b/doc/DropboxApi/Endpoints/RpcNotify.html new file mode 100644 index 00000000..4a78b83a --- /dev/null +++ b/doc/DropboxApi/Endpoints/RpcNotify.html @@ -0,0 +1,156 @@ + + + + + + +class DropboxApi::Endpoints::RpcNotify - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::RpcNotify +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ build_connection() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/endpoints/rpc_notify.rb, line 3
+def build_connection
+  @connection = @builder.build('https://notify.dropboxapi.com') do |c|
+    c.builder.handlers.delete(Faraday::Request::Authorization)
+
+    c.response :decode_result
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Sharing.html b/doc/DropboxApi/Endpoints/Sharing.html new file mode 100644 index 00000000..830f39f3 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Sharing.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::Endpoints::Sharing - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::Endpoints::Sharing +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Sharing/AddFileMember.html b/doc/DropboxApi/Endpoints/Sharing/AddFileMember.html new file mode 100644 index 00000000..92dec90c --- /dev/null +++ b/doc/DropboxApi/Endpoints/Sharing/AddFileMember.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Sharing::AddFileMember - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Sharing::AddFileMember +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Sharing/AddFolderMember.html b/doc/DropboxApi/Endpoints/Sharing/AddFolderMember.html new file mode 100644 index 00000000..cfc4df08 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Sharing/AddFolderMember.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Sharing::AddFolderMember - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Sharing::AddFolderMember +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html b/doc/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html new file mode 100644 index 00000000..afead937 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html b/doc/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html new file mode 100644 index 00000000..c257bd40 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Sharing/ListFileMembers.html b/doc/DropboxApi/Endpoints/Sharing/ListFileMembers.html new file mode 100644 index 00000000..5a6ffc20 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Sharing/ListFileMembers.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Sharing::ListFileMembers - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Sharing::ListFileMembers +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Sharing/ListFolderMembers.html b/doc/DropboxApi/Endpoints/Sharing/ListFolderMembers.html new file mode 100644 index 00000000..e238a2bc --- /dev/null +++ b/doc/DropboxApi/Endpoints/Sharing/ListFolderMembers.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Sharing::ListFolderMembers - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Sharing::ListFolderMembers +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Sharing/ListSharedLinks.html b/doc/DropboxApi/Endpoints/Sharing/ListSharedLinks.html new file mode 100644 index 00000000..d873a9a1 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Sharing/ListSharedLinks.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Sharing::ListSharedLinks - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Sharing::ListSharedLinks +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Sharing/RevokeSharedLink.html b/doc/DropboxApi/Endpoints/Sharing/RevokeSharedLink.html new file mode 100644 index 00000000..6a5d333d --- /dev/null +++ b/doc/DropboxApi/Endpoints/Sharing/RevokeSharedLink.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Sharing::RevokeSharedLink - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Sharing::RevokeSharedLink +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Sharing/ShareFolder.html b/doc/DropboxApi/Endpoints/Sharing/ShareFolder.html new file mode 100644 index 00000000..70e7b6d1 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Sharing/ShareFolder.html @@ -0,0 +1,141 @@ + + + + + + +class DropboxApi::Endpoints::Sharing::ShareFolder - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Sharing::ShareFolder +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Sharing/UnshareFile.html b/doc/DropboxApi/Endpoints/Sharing/UnshareFile.html new file mode 100644 index 00000000..7400101c --- /dev/null +++ b/doc/DropboxApi/Endpoints/Sharing/UnshareFile.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Sharing::UnshareFile - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Sharing::UnshareFile +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Users.html b/doc/DropboxApi/Endpoints/Users.html new file mode 100644 index 00000000..d8c0b3b9 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Users.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::Endpoints::Users - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::Endpoints::Users +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Users/GetAccount.html b/doc/DropboxApi/Endpoints/Users/GetAccount.html new file mode 100644 index 00000000..cbf7fe45 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Users/GetAccount.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Users::GetAccount - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Users::GetAccount +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Users/GetAccountBatch.html b/doc/DropboxApi/Endpoints/Users/GetAccountBatch.html new file mode 100644 index 00000000..b6eb5be3 --- /dev/null +++ b/doc/DropboxApi/Endpoints/Users/GetAccountBatch.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Users::GetAccountBatch - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Users::GetAccountBatch +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Users/GetCurrentAccount.html b/doc/DropboxApi/Endpoints/Users/GetCurrentAccount.html new file mode 100644 index 00000000..bc3744db --- /dev/null +++ b/doc/DropboxApi/Endpoints/Users/GetCurrentAccount.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Users::GetCurrentAccount - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Users::GetCurrentAccount +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Endpoints/Users/GetSpaceUsage.html b/doc/DropboxApi/Endpoints/Users/GetSpaceUsage.html new file mode 100644 index 00000000..ba9cf3db --- /dev/null +++ b/doc/DropboxApi/Endpoints/Users/GetSpaceUsage.html @@ -0,0 +1,130 @@ + + + + + + +class DropboxApi::Endpoints::Users::GetSpaceUsage - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Endpoints::Users::GetSpaceUsage +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorType + +
+ + +
Method + +
+ + +
Path + +
+ + +
ResultType + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors.html b/doc/DropboxApi/Errors.html new file mode 100644 index 00000000..8c99ae87 --- /dev/null +++ b/doc/DropboxApi/Errors.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::Errors - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::Errors +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/AddFileMemberError.html b/doc/DropboxApi/Errors/AddFileMemberError.html new file mode 100644 index 00000000..e52acbf6 --- /dev/null +++ b/doc/DropboxApi/Errors/AddFileMemberError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::AddFileMemberError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::AddFileMemberError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/AddFolderMemberError.html b/doc/DropboxApi/Errors/AddFolderMemberError.html new file mode 100644 index 00000000..914f3eaf --- /dev/null +++ b/doc/DropboxApi/Errors/AddFolderMemberError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::AddFolderMemberError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::AddFolderMemberError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/AddMemberSelectorError.html b/doc/DropboxApi/Errors/AddMemberSelectorError.html new file mode 100644 index 00000000..dbd812e8 --- /dev/null +++ b/doc/DropboxApi/Errors/AddMemberSelectorError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::AddMemberSelectorError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::AddMemberSelectorError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/AlreadySharedError.html b/doc/DropboxApi/Errors/AlreadySharedError.html new file mode 100644 index 00000000..b45b9ed2 --- /dev/null +++ b/doc/DropboxApi/Errors/AlreadySharedError.html @@ -0,0 +1,152 @@ + + + + + + +class DropboxApi::Errors::AlreadySharedError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::AlreadySharedError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ shared_folder() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/errors/already_shared_error.rb, line 3
+def shared_folder
+  DropboxApi::Metadata::SharedFolder.new @metadata
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Errors/BadPathError.html b/doc/DropboxApi/Errors/BadPathError.html new file mode 100644 index 00000000..66e82845 --- /dev/null +++ b/doc/DropboxApi/Errors/BadPathError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::BadPathError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::BadPathError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/BasicError.html b/doc/DropboxApi/Errors/BasicError.html new file mode 100644 index 00000000..5ede4228 --- /dev/null +++ b/doc/DropboxApi/Errors/BasicError.html @@ -0,0 +1,240 @@ + + + + + + +class DropboxApi::Errors::BasicError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::BasicError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ build(message, metadata) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/errors/basic_error.rb, line 9
+def build(message, metadata)
+  subtype, metadata = find_subtype metadata
+
+  if subtype.nil?
+    new message, metadata
+  else
+    subtype.build message, metadata
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ find_subtype(metadata) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/errors/basic_error.rb, line 19
+def find_subtype(metadata)
+  if defined? self::ErrorSubtypes
+    discriminator = metadata['.tag']
+    metadata = metadata[discriminator] unless metadata[discriminator].nil?
+    [self::ErrorSubtypes[discriminator.to_sym], metadata]
+  else
+    [nil, metadata]
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ new(message, metadata) + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + +
+ + + +
+
# File lib/dropbox_api/errors/basic_error.rb, line 3
+def initialize(message, metadata)
+  @metadata = metadata
+  super message
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Errors/CantCopySharedFolderError.html b/doc/DropboxApi/Errors/CantCopySharedFolderError.html new file mode 100644 index 00000000..332c0181 --- /dev/null +++ b/doc/DropboxApi/Errors/CantCopySharedFolderError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::CantCopySharedFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::CantCopySharedFolderError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/CantMoveFolderIntoItselfError.html b/doc/DropboxApi/Errors/CantMoveFolderIntoItselfError.html new file mode 100644 index 00000000..b69316bd --- /dev/null +++ b/doc/DropboxApi/Errors/CantMoveFolderIntoItselfError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::CantMoveFolderIntoItselfError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::CantMoveFolderIntoItselfError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/CantNestSharedFolderError.html b/doc/DropboxApi/Errors/CantNestSharedFolderError.html new file mode 100644 index 00000000..63e3a3d9 --- /dev/null +++ b/doc/DropboxApi/Errors/CantNestSharedFolderError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::CantNestSharedFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::CantNestSharedFolderError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/CantShareOutsideTeamError.html b/doc/DropboxApi/Errors/CantShareOutsideTeamError.html new file mode 100644 index 00000000..8a047db6 --- /dev/null +++ b/doc/DropboxApi/Errors/CantShareOutsideTeamError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::CantShareOutsideTeamError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::CantShareOutsideTeamError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/ContainsSharedFolderError.html b/doc/DropboxApi/Errors/ContainsSharedFolderError.html new file mode 100644 index 00000000..51096fb7 --- /dev/null +++ b/doc/DropboxApi/Errors/ContainsSharedFolderError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::ContainsSharedFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::ContainsSharedFolderError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/ConversionError.html b/doc/DropboxApi/Errors/ConversionError.html new file mode 100644 index 00000000..4ca22de4 --- /dev/null +++ b/doc/DropboxApi/Errors/ConversionError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::ConversionError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::ConversionError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/CreateFileRequestError.html b/doc/DropboxApi/Errors/CreateFileRequestError.html new file mode 100644 index 00000000..d8cfd658 --- /dev/null +++ b/doc/DropboxApi/Errors/CreateFileRequestError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::CreateFileRequestError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::CreateFileRequestError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/CreateFolderBatchError.html b/doc/DropboxApi/Errors/CreateFolderBatchError.html new file mode 100644 index 00000000..4e2ef81d --- /dev/null +++ b/doc/DropboxApi/Errors/CreateFolderBatchError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::CreateFolderBatchError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::CreateFolderBatchError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/CreateFolderError.html b/doc/DropboxApi/Errors/CreateFolderError.html new file mode 100644 index 00000000..fa2d2fea --- /dev/null +++ b/doc/DropboxApi/Errors/CreateFolderError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::CreateFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::CreateFolderError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html b/doc/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html new file mode 100644 index 00000000..ee10ca19 --- /dev/null +++ b/doc/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::CreateSharedLinkWithSettingsError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::CreateSharedLinkWithSettingsError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/CursorClosedError.html b/doc/DropboxApi/Errors/CursorClosedError.html new file mode 100644 index 00000000..0110f436 --- /dev/null +++ b/doc/DropboxApi/Errors/CursorClosedError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::CursorClosedError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::CursorClosedError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/CursorNotClosedError.html b/doc/DropboxApi/Errors/CursorNotClosedError.html new file mode 100644 index 00000000..f60da1a3 --- /dev/null +++ b/doc/DropboxApi/Errors/CursorNotClosedError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::CursorNotClosedError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::CursorNotClosedError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/DeleteError.html b/doc/DropboxApi/Errors/DeleteError.html new file mode 100644 index 00000000..8f3fb67e --- /dev/null +++ b/doc/DropboxApi/Errors/DeleteError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::DeleteError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::DeleteError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/DisallowedNameError.html b/doc/DropboxApi/Errors/DisallowedNameError.html new file mode 100644 index 00000000..c09d3a1f --- /dev/null +++ b/doc/DropboxApi/Errors/DisallowedNameError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::DisallowedNameError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::DisallowedNameError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html b/doc/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html new file mode 100644 index 00000000..8ada644e --- /dev/null +++ b/doc/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::DisallowedSharedLinkPolicyError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::DisallowedSharedLinkPolicyError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/DownloadError.html b/doc/DropboxApi/Errors/DownloadError.html new file mode 100644 index 00000000..9ac30d2d --- /dev/null +++ b/doc/DropboxApi/Errors/DownloadError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::DownloadError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::DownloadError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/DownloadFailedError.html b/doc/DropboxApi/Errors/DownloadFailedError.html new file mode 100644 index 00000000..9c38b1f3 --- /dev/null +++ b/doc/DropboxApi/Errors/DownloadFailedError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::DownloadFailedError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::DownloadFailedError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/EmailUnverifiedError.html b/doc/DropboxApi/Errors/EmailUnverifiedError.html new file mode 100644 index 00000000..edf198fa --- /dev/null +++ b/doc/DropboxApi/Errors/EmailUnverifiedError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::EmailUnverifiedError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::EmailUnverifiedError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/ExpiredAccessTokenError.html b/doc/DropboxApi/Errors/ExpiredAccessTokenError.html new file mode 100644 index 00000000..068cfd36 --- /dev/null +++ b/doc/DropboxApi/Errors/ExpiredAccessTokenError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::ExpiredAccessTokenError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::ExpiredAccessTokenError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/FileAncestorConflictError.html b/doc/DropboxApi/Errors/FileAncestorConflictError.html new file mode 100644 index 00000000..68acec2a --- /dev/null +++ b/doc/DropboxApi/Errors/FileAncestorConflictError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::FileAncestorConflictError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::FileAncestorConflictError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/FileConflictError.html b/doc/DropboxApi/Errors/FileConflictError.html new file mode 100644 index 00000000..47746bc6 --- /dev/null +++ b/doc/DropboxApi/Errors/FileConflictError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::FileConflictError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::FileConflictError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/FileMemberActionError.html b/doc/DropboxApi/Errors/FileMemberActionError.html new file mode 100644 index 00000000..aeaff976 --- /dev/null +++ b/doc/DropboxApi/Errors/FileMemberActionError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::FileMemberActionError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::FileMemberActionError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/FolderConflictError.html b/doc/DropboxApi/Errors/FolderConflictError.html new file mode 100644 index 00000000..b831a74b --- /dev/null +++ b/doc/DropboxApi/Errors/FolderConflictError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::FolderConflictError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::FolderConflictError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/GetAccountError.html b/doc/DropboxApi/Errors/GetAccountError.html new file mode 100644 index 00000000..9143e50c --- /dev/null +++ b/doc/DropboxApi/Errors/GetAccountError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::GetAccountError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::GetAccountError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/GetCopyReferenceError.html b/doc/DropboxApi/Errors/GetCopyReferenceError.html new file mode 100644 index 00000000..04d1e0f7 --- /dev/null +++ b/doc/DropboxApi/Errors/GetCopyReferenceError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::GetCopyReferenceError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::GetCopyReferenceError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/GetMetadataError.html b/doc/DropboxApi/Errors/GetMetadataError.html new file mode 100644 index 00000000..e609b269 --- /dev/null +++ b/doc/DropboxApi/Errors/GetMetadataError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::GetMetadataError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::GetMetadataError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/GroupDeletedError.html b/doc/DropboxApi/Errors/GroupDeletedError.html new file mode 100644 index 00000000..7e7f3ad3 --- /dev/null +++ b/doc/DropboxApi/Errors/GroupDeletedError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::GroupDeletedError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::GroupDeletedError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/GroupNotOnTeamError.html b/doc/DropboxApi/Errors/GroupNotOnTeamError.html new file mode 100644 index 00000000..3a9f088a --- /dev/null +++ b/doc/DropboxApi/Errors/GroupNotOnTeamError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::GroupNotOnTeamError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::GroupNotOnTeamError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/HttpError.html b/doc/DropboxApi/Errors/HttpError.html new file mode 100644 index 00000000..7e2b3dd0 --- /dev/null +++ b/doc/DropboxApi/Errors/HttpError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::HttpError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::HttpError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InProgressError.html b/doc/DropboxApi/Errors/InProgressError.html new file mode 100644 index 00000000..d1120e6f --- /dev/null +++ b/doc/DropboxApi/Errors/InProgressError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InProgressError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InProgressError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InsideAppFolderError.html b/doc/DropboxApi/Errors/InsideAppFolderError.html new file mode 100644 index 00000000..6b4ba805 --- /dev/null +++ b/doc/DropboxApi/Errors/InsideAppFolderError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InsideAppFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InsideAppFolderError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InsideOsxPackageError.html b/doc/DropboxApi/Errors/InsideOsxPackageError.html new file mode 100644 index 00000000..5b81b739 --- /dev/null +++ b/doc/DropboxApi/Errors/InsideOsxPackageError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InsideOsxPackageError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InsideOsxPackageError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InsidePublicFolderError.html b/doc/DropboxApi/Errors/InsidePublicFolderError.html new file mode 100644 index 00000000..9b5decbb --- /dev/null +++ b/doc/DropboxApi/Errors/InsidePublicFolderError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InsidePublicFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InsidePublicFolderError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InsideSharedFolderError.html b/doc/DropboxApi/Errors/InsideSharedFolderError.html new file mode 100644 index 00000000..defa2b69 --- /dev/null +++ b/doc/DropboxApi/Errors/InsideSharedFolderError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InsideSharedFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InsideSharedFolderError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InsufficientPlanError.html b/doc/DropboxApi/Errors/InsufficientPlanError.html new file mode 100644 index 00000000..e7977960 --- /dev/null +++ b/doc/DropboxApi/Errors/InsufficientPlanError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InsufficientPlanError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InsufficientPlanError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InsufficientSpaceError.html b/doc/DropboxApi/Errors/InsufficientSpaceError.html new file mode 100644 index 00000000..31e8bfd8 --- /dev/null +++ b/doc/DropboxApi/Errors/InsufficientSpaceError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InsufficientSpaceError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InsufficientSpaceError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InternalError.html b/doc/DropboxApi/Errors/InternalError.html new file mode 100644 index 00000000..c9c49fff --- /dev/null +++ b/doc/DropboxApi/Errors/InternalError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InternalError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InternalError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InvalidCommentError.html b/doc/DropboxApi/Errors/InvalidCommentError.html new file mode 100644 index 00000000..b924411a --- /dev/null +++ b/doc/DropboxApi/Errors/InvalidCommentError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InvalidCommentError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InvalidCommentError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InvalidCopyReferenceError.html b/doc/DropboxApi/Errors/InvalidCopyReferenceError.html new file mode 100644 index 00000000..1f5deb56 --- /dev/null +++ b/doc/DropboxApi/Errors/InvalidCopyReferenceError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InvalidCopyReferenceError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InvalidCopyReferenceError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InvalidCursorError.html b/doc/DropboxApi/Errors/InvalidCursorError.html new file mode 100644 index 00000000..c3751903 --- /dev/null +++ b/doc/DropboxApi/Errors/InvalidCursorError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InvalidCursorError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InvalidCursorError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InvalidDropboxIdError.html b/doc/DropboxApi/Errors/InvalidDropboxIdError.html new file mode 100644 index 00000000..fd366933 --- /dev/null +++ b/doc/DropboxApi/Errors/InvalidDropboxIdError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InvalidDropboxIdError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InvalidDropboxIdError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InvalidEmailError.html b/doc/DropboxApi/Errors/InvalidEmailError.html new file mode 100644 index 00000000..fbdca10d --- /dev/null +++ b/doc/DropboxApi/Errors/InvalidEmailError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InvalidEmailError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InvalidEmailError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InvalidFileError.html b/doc/DropboxApi/Errors/InvalidFileError.html new file mode 100644 index 00000000..1bfa5860 --- /dev/null +++ b/doc/DropboxApi/Errors/InvalidFileError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InvalidFileError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InvalidFileError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InvalidIdError.html b/doc/DropboxApi/Errors/InvalidIdError.html new file mode 100644 index 00000000..d0a4bdbf --- /dev/null +++ b/doc/DropboxApi/Errors/InvalidIdError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InvalidIdError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InvalidIdError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InvalidMemberError.html b/doc/DropboxApi/Errors/InvalidMemberError.html new file mode 100644 index 00000000..4c1d715b --- /dev/null +++ b/doc/DropboxApi/Errors/InvalidMemberError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InvalidMemberError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InvalidMemberError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InvalidPathError.html b/doc/DropboxApi/Errors/InvalidPathError.html new file mode 100644 index 00000000..a75faa2d --- /dev/null +++ b/doc/DropboxApi/Errors/InvalidPathError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InvalidPathError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InvalidPathError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InvalidRevisionError.html b/doc/DropboxApi/Errors/InvalidRevisionError.html new file mode 100644 index 00000000..d144797c --- /dev/null +++ b/doc/DropboxApi/Errors/InvalidRevisionError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InvalidRevisionError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InvalidRevisionError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InvalidSettingsError.html b/doc/DropboxApi/Errors/InvalidSettingsError.html new file mode 100644 index 00000000..1c0af4dc --- /dev/null +++ b/doc/DropboxApi/Errors/InvalidSettingsError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InvalidSettingsError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InvalidSettingsError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/InvalidUrlError.html b/doc/DropboxApi/Errors/InvalidUrlError.html new file mode 100644 index 00000000..6b1ed318 --- /dev/null +++ b/doc/DropboxApi/Errors/InvalidUrlError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::InvalidUrlError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::InvalidUrlError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/IsAppFolderError.html b/doc/DropboxApi/Errors/IsAppFolderError.html new file mode 100644 index 00000000..59f832b5 --- /dev/null +++ b/doc/DropboxApi/Errors/IsAppFolderError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::IsAppFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::IsAppFolderError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/IsFileError.html b/doc/DropboxApi/Errors/IsFileError.html new file mode 100644 index 00000000..532fa7cd --- /dev/null +++ b/doc/DropboxApi/Errors/IsFileError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::IsFileError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::IsFileError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/IsFolderError.html b/doc/DropboxApi/Errors/IsFolderError.html new file mode 100644 index 00000000..3f7bfb4c --- /dev/null +++ b/doc/DropboxApi/Errors/IsFolderError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::IsFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::IsFolderError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/IsOsxPackageError.html b/doc/DropboxApi/Errors/IsOsxPackageError.html new file mode 100644 index 00000000..51cca7d9 --- /dev/null +++ b/doc/DropboxApi/Errors/IsOsxPackageError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::IsOsxPackageError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::IsOsxPackageError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/IsPublicFolderError.html b/doc/DropboxApi/Errors/IsPublicFolderError.html new file mode 100644 index 00000000..0917b5ea --- /dev/null +++ b/doc/DropboxApi/Errors/IsPublicFolderError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::IsPublicFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::IsPublicFolderError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/ListFolderContinueError.html b/doc/DropboxApi/Errors/ListFolderContinueError.html new file mode 100644 index 00000000..25ee8f10 --- /dev/null +++ b/doc/DropboxApi/Errors/ListFolderContinueError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::ListFolderContinueError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::ListFolderContinueError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/ListFolderError.html b/doc/DropboxApi/Errors/ListFolderError.html new file mode 100644 index 00000000..7a2b4857 --- /dev/null +++ b/doc/DropboxApi/Errors/ListFolderError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::ListFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::ListFolderError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/ListFolderLongpollError.html b/doc/DropboxApi/Errors/ListFolderLongpollError.html new file mode 100644 index 00000000..523a9ec8 --- /dev/null +++ b/doc/DropboxApi/Errors/ListFolderLongpollError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::ListFolderLongpollError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::ListFolderLongpollError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/ListRevisionsError.html b/doc/DropboxApi/Errors/ListRevisionsError.html new file mode 100644 index 00000000..570d1f7d --- /dev/null +++ b/doc/DropboxApi/Errors/ListRevisionsError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::ListRevisionsError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::ListRevisionsError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/ListSharedLinksError.html b/doc/DropboxApi/Errors/ListSharedLinksError.html new file mode 100644 index 00000000..ed7b5fd5 --- /dev/null +++ b/doc/DropboxApi/Errors/ListSharedLinksError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::ListSharedLinksError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::ListSharedLinksError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/LookupError.html b/doc/DropboxApi/Errors/LookupError.html new file mode 100644 index 00000000..8805c1da --- /dev/null +++ b/doc/DropboxApi/Errors/LookupError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::LookupError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::LookupError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/MalformedPathError.html b/doc/DropboxApi/Errors/MalformedPathError.html new file mode 100644 index 00000000..d035a881 --- /dev/null +++ b/doc/DropboxApi/Errors/MalformedPathError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::MalformedPathError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::MalformedPathError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/NoAccountError.html b/doc/DropboxApi/Errors/NoAccountError.html new file mode 100644 index 00000000..dde5957a --- /dev/null +++ b/doc/DropboxApi/Errors/NoAccountError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::NoAccountError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::NoAccountError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/NoPermissionError.html b/doc/DropboxApi/Errors/NoPermissionError.html new file mode 100644 index 00000000..5ec63b78 --- /dev/null +++ b/doc/DropboxApi/Errors/NoPermissionError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::NoPermissionError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::NoPermissionError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/NoWritePermissionError.html b/doc/DropboxApi/Errors/NoWritePermissionError.html new file mode 100644 index 00000000..7e71b30e --- /dev/null +++ b/doc/DropboxApi/Errors/NoWritePermissionError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::NoWritePermissionError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::NoWritePermissionError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/NotAMemberError.html b/doc/DropboxApi/Errors/NotAMemberError.html new file mode 100644 index 00000000..19c3c33b --- /dev/null +++ b/doc/DropboxApi/Errors/NotAMemberError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::NotAMemberError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::NotAMemberError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/NotFileError.html b/doc/DropboxApi/Errors/NotFileError.html new file mode 100644 index 00000000..f69159a0 --- /dev/null +++ b/doc/DropboxApi/Errors/NotFileError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::NotFileError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::NotFileError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/NotFolderError.html b/doc/DropboxApi/Errors/NotFolderError.html new file mode 100644 index 00000000..757205ec --- /dev/null +++ b/doc/DropboxApi/Errors/NotFolderError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::NotFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::NotFolderError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/NotFoundError.html b/doc/DropboxApi/Errors/NotFoundError.html new file mode 100644 index 00000000..1ef5cbc1 --- /dev/null +++ b/doc/DropboxApi/Errors/NotFoundError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::NotFoundError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::NotFoundError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/PollError.html b/doc/DropboxApi/Errors/PollError.html new file mode 100644 index 00000000..ab5870fa --- /dev/null +++ b/doc/DropboxApi/Errors/PollError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::PollError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::PollError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/PreviewError.html b/doc/DropboxApi/Errors/PreviewError.html new file mode 100644 index 00000000..56f8ff4d --- /dev/null +++ b/doc/DropboxApi/Errors/PreviewError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::PreviewError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::PreviewError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/RateLimitError.html b/doc/DropboxApi/Errors/RateLimitError.html new file mode 100644 index 00000000..8e015ae4 --- /dev/null +++ b/doc/DropboxApi/Errors/RateLimitError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::RateLimitError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::RateLimitError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/RelocationBatchEntryError.html b/doc/DropboxApi/Errors/RelocationBatchEntryError.html new file mode 100644 index 00000000..3ac702c3 --- /dev/null +++ b/doc/DropboxApi/Errors/RelocationBatchEntryError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::RelocationBatchEntryError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::RelocationBatchEntryError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/RelocationError.html b/doc/DropboxApi/Errors/RelocationError.html new file mode 100644 index 00000000..97091ed7 --- /dev/null +++ b/doc/DropboxApi/Errors/RelocationError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::RelocationError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::RelocationError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/RestoreError.html b/doc/DropboxApi/Errors/RestoreError.html new file mode 100644 index 00000000..4a7476e7 --- /dev/null +++ b/doc/DropboxApi/Errors/RestoreError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::RestoreError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::RestoreError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/RestrictedContentError.html b/doc/DropboxApi/Errors/RestrictedContentError.html new file mode 100644 index 00000000..e2f14af0 --- /dev/null +++ b/doc/DropboxApi/Errors/RestrictedContentError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::RestrictedContentError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::RestrictedContentError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/RevokeSharedLinkError.html b/doc/DropboxApi/Errors/RevokeSharedLinkError.html new file mode 100644 index 00000000..121455d0 --- /dev/null +++ b/doc/DropboxApi/Errors/RevokeSharedLinkError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::RevokeSharedLinkError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::RevokeSharedLinkError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SaveCopyReferenceError.html b/doc/DropboxApi/Errors/SaveCopyReferenceError.html new file mode 100644 index 00000000..f160e4db --- /dev/null +++ b/doc/DropboxApi/Errors/SaveCopyReferenceError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::SaveCopyReferenceError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SaveCopyReferenceError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SaveUrlError.html b/doc/DropboxApi/Errors/SaveUrlError.html new file mode 100644 index 00000000..e645ca6c --- /dev/null +++ b/doc/DropboxApi/Errors/SaveUrlError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::SaveUrlError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SaveUrlError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SearchError.html b/doc/DropboxApi/Errors/SearchError.html new file mode 100644 index 00000000..18375e01 --- /dev/null +++ b/doc/DropboxApi/Errors/SearchError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::SearchError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SearchError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SettingsError.html b/doc/DropboxApi/Errors/SettingsError.html new file mode 100644 index 00000000..8127d4bb --- /dev/null +++ b/doc/DropboxApi/Errors/SettingsError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::SettingsError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SettingsError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/ShareFolderError.html b/doc/DropboxApi/Errors/ShareFolderError.html new file mode 100644 index 00000000..b45b988e --- /dev/null +++ b/doc/DropboxApi/Errors/ShareFolderError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::ShareFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::ShareFolderError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SharePathError.html b/doc/DropboxApi/Errors/SharePathError.html new file mode 100644 index 00000000..c95e15d8 --- /dev/null +++ b/doc/DropboxApi/Errors/SharePathError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::SharePathError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SharePathError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SharedFolderAccessError.html b/doc/DropboxApi/Errors/SharedFolderAccessError.html new file mode 100644 index 00000000..3c31c82e --- /dev/null +++ b/doc/DropboxApi/Errors/SharedFolderAccessError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::SharedFolderAccessError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SharedFolderAccessError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SharedLinkAccessDeniedError.html b/doc/DropboxApi/Errors/SharedLinkAccessDeniedError.html new file mode 100644 index 00000000..2087fd7d --- /dev/null +++ b/doc/DropboxApi/Errors/SharedLinkAccessDeniedError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::SharedLinkAccessDeniedError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SharedLinkAccessDeniedError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SharedLinkAlreadyExistsError.html b/doc/DropboxApi/Errors/SharedLinkAlreadyExistsError.html new file mode 100644 index 00000000..1d66d651 --- /dev/null +++ b/doc/DropboxApi/Errors/SharedLinkAlreadyExistsError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::SharedLinkAlreadyExistsError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SharedLinkAlreadyExistsError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SharedLinkError.html b/doc/DropboxApi/Errors/SharedLinkError.html new file mode 100644 index 00000000..a5536875 --- /dev/null +++ b/doc/DropboxApi/Errors/SharedLinkError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::SharedLinkError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SharedLinkError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SharedLinkMalformedError.html b/doc/DropboxApi/Errors/SharedLinkMalformedError.html new file mode 100644 index 00000000..e30e8d0c --- /dev/null +++ b/doc/DropboxApi/Errors/SharedLinkMalformedError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::SharedLinkMalformedError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SharedLinkMalformedError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SharedLinkNotFoundError.html b/doc/DropboxApi/Errors/SharedLinkNotFoundError.html new file mode 100644 index 00000000..a68cd316 --- /dev/null +++ b/doc/DropboxApi/Errors/SharedLinkNotFoundError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::SharedLinkNotFoundError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SharedLinkNotFoundError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SharingFileAccessError.html b/doc/DropboxApi/Errors/SharingFileAccessError.html new file mode 100644 index 00000000..9839d2c5 --- /dev/null +++ b/doc/DropboxApi/Errors/SharingFileAccessError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::SharingFileAccessError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SharingFileAccessError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/SharingUserError.html b/doc/DropboxApi/Errors/SharingUserError.html new file mode 100644 index 00000000..1451c6c2 --- /dev/null +++ b/doc/DropboxApi/Errors/SharingUserError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::SharingUserError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::SharingUserError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/TeamFolderError.html b/doc/DropboxApi/Errors/TeamFolderError.html new file mode 100644 index 00000000..c49ce0bc --- /dev/null +++ b/doc/DropboxApi/Errors/TeamFolderError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::TeamFolderError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::TeamFolderError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html b/doc/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html new file mode 100644 index 00000000..f6601186 --- /dev/null +++ b/doc/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/ThumbnailBatchError.html b/doc/DropboxApi/Errors/ThumbnailBatchError.html new file mode 100644 index 00000000..21b82c18 --- /dev/null +++ b/doc/DropboxApi/Errors/ThumbnailBatchError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::ThumbnailBatchError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::ThumbnailBatchError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/ThumbnailError.html b/doc/DropboxApi/Errors/ThumbnailError.html new file mode 100644 index 00000000..de227032 --- /dev/null +++ b/doc/DropboxApi/Errors/ThumbnailError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::ThumbnailError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::ThumbnailError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/TooManyFilesError.html b/doc/DropboxApi/Errors/TooManyFilesError.html new file mode 100644 index 00000000..77a6e624 --- /dev/null +++ b/doc/DropboxApi/Errors/TooManyFilesError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::TooManyFilesError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::TooManyFilesError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/TooManyMembersError.html b/doc/DropboxApi/Errors/TooManyMembersError.html new file mode 100644 index 00000000..5c9a42be --- /dev/null +++ b/doc/DropboxApi/Errors/TooManyMembersError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::TooManyMembersError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::TooManyMembersError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/TooManyPendingInvitesError.html b/doc/DropboxApi/Errors/TooManyPendingInvitesError.html new file mode 100644 index 00000000..87e5beaf --- /dev/null +++ b/doc/DropboxApi/Errors/TooManyPendingInvitesError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::TooManyPendingInvitesError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::TooManyPendingInvitesError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/TooManyRequestsError.html b/doc/DropboxApi/Errors/TooManyRequestsError.html new file mode 100644 index 00000000..5bf4ee93 --- /dev/null +++ b/doc/DropboxApi/Errors/TooManyRequestsError.html @@ -0,0 +1,189 @@ + + + + + + +class DropboxApi::Errors::TooManyRequestsError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::TooManyRequestsError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + +
+
+

Attributes

+
+ + +
+
+ retry_after[RW] +
+ +
+ + + +
+
+ +
+ + + +
+
+

Public Class Methods

+
+ + +
+ +
+ build(message, metadata) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/errors/too_many_requests_error.rb, line 8
+def self.build(message, metadata)
+  subtype, metadata = find_subtype metadata
+
+  subtype.new(message, metadata)
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Errors/TooManySharedFolderTargetsError.html b/doc/DropboxApi/Errors/TooManySharedFolderTargetsError.html new file mode 100644 index 00000000..24ec8bbf --- /dev/null +++ b/doc/DropboxApi/Errors/TooManySharedFolderTargetsError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::TooManySharedFolderTargetsError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::TooManySharedFolderTargetsError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/TooManyWriteOperationsError.html b/doc/DropboxApi/Errors/TooManyWriteOperationsError.html new file mode 100644 index 00000000..26a2f6ee --- /dev/null +++ b/doc/DropboxApi/Errors/TooManyWriteOperationsError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::TooManyWriteOperationsError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::TooManyWriteOperationsError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/UnmountedError.html b/doc/DropboxApi/Errors/UnmountedError.html new file mode 100644 index 00000000..cbcf6612 --- /dev/null +++ b/doc/DropboxApi/Errors/UnmountedError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::UnmountedError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::UnmountedError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/UnshareFileError.html b/doc/DropboxApi/Errors/UnshareFileError.html new file mode 100644 index 00000000..b3e47a37 --- /dev/null +++ b/doc/DropboxApi/Errors/UnshareFileError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::UnshareFileError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::UnshareFileError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/UnsupportedContentError.html b/doc/DropboxApi/Errors/UnsupportedContentError.html new file mode 100644 index 00000000..48e071f0 --- /dev/null +++ b/doc/DropboxApi/Errors/UnsupportedContentError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::UnsupportedContentError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::UnsupportedContentError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/UnsupportedExtensionError.html b/doc/DropboxApi/Errors/UnsupportedExtensionError.html new file mode 100644 index 00000000..9fd5f07a --- /dev/null +++ b/doc/DropboxApi/Errors/UnsupportedExtensionError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::UnsupportedExtensionError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::UnsupportedExtensionError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/UnsupportedImageError.html b/doc/DropboxApi/Errors/UnsupportedImageError.html new file mode 100644 index 00000000..6df2d51a --- /dev/null +++ b/doc/DropboxApi/Errors/UnsupportedImageError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::UnsupportedImageError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::UnsupportedImageError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/UnsupportedLinkTypeError.html b/doc/DropboxApi/Errors/UnsupportedLinkTypeError.html new file mode 100644 index 00000000..1b2f1ddb --- /dev/null +++ b/doc/DropboxApi/Errors/UnsupportedLinkTypeError.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::UnsupportedLinkTypeError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::UnsupportedLinkTypeError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/UnverifiedDropboxId.html b/doc/DropboxApi/Errors/UnverifiedDropboxId.html new file mode 100644 index 00000000..39d9fa50 --- /dev/null +++ b/doc/DropboxApi/Errors/UnverifiedDropboxId.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Errors::UnverifiedDropboxId - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::UnverifiedDropboxId +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/UploadError.html b/doc/DropboxApi/Errors/UploadError.html new file mode 100644 index 00000000..661db2fa --- /dev/null +++ b/doc/DropboxApi/Errors/UploadError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::UploadError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::UploadError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/UploadSessionFinishError.html b/doc/DropboxApi/Errors/UploadSessionFinishError.html new file mode 100644 index 00000000..7856f122 --- /dev/null +++ b/doc/DropboxApi/Errors/UploadSessionFinishError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::UploadSessionFinishError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::UploadSessionFinishError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/UploadSessionLookupError.html b/doc/DropboxApi/Errors/UploadSessionLookupError.html new file mode 100644 index 00000000..cc8b9e69 --- /dev/null +++ b/doc/DropboxApi/Errors/UploadSessionLookupError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::UploadSessionLookupError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::UploadSessionLookupError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/UploadSessionOffsetError.html b/doc/DropboxApi/Errors/UploadSessionOffsetError.html new file mode 100644 index 00000000..d4d916bc --- /dev/null +++ b/doc/DropboxApi/Errors/UploadSessionOffsetError.html @@ -0,0 +1,158 @@ + + + + + + +class DropboxApi::Errors::UploadSessionOffsetError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::UploadSessionOffsetError +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(message, metadata) + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + DropboxApi::Errors::BasicError.new +
+ + + +
+
# File lib/dropbox_api/errors/upload_session_offset_error.rb, line 3
+def initialize(message, metadata)
+  message = "#{message}, correct offset: #{metadata['correct_offset']}"
+  super message, metadata
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Errors/UploadWriteFailedError.html b/doc/DropboxApi/Errors/UploadWriteFailedError.html new file mode 100644 index 00000000..e854c7c1 --- /dev/null +++ b/doc/DropboxApi/Errors/UploadWriteFailedError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::UploadWriteFailedError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::UploadWriteFailedError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/WriteConflictError.html b/doc/DropboxApi/Errors/WriteConflictError.html new file mode 100644 index 00000000..cfb1e233 --- /dev/null +++ b/doc/DropboxApi/Errors/WriteConflictError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::WriteConflictError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::WriteConflictError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Errors/WriteError.html b/doc/DropboxApi/Errors/WriteError.html new file mode 100644 index 00000000..51bf0a22 --- /dev/null +++ b/doc/DropboxApi/Errors/WriteError.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Errors::WriteError - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Errors::WriteError +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
ErrorSubtypes + +
+ + +
+
+ + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Faraday.html b/doc/DropboxApi/Faraday.html new file mode 100644 index 00000000..ce7cb34c --- /dev/null +++ b/doc/DropboxApi/Faraday.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::Faraday - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::Faraday +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Faraday/Adapter.html b/doc/DropboxApi/Faraday/Adapter.html new file mode 100644 index 00000000..fdbe04cd --- /dev/null +++ b/doc/DropboxApi/Faraday/Adapter.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::Faraday::Adapter - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::Faraday::Adapter +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Faraday/Request.html b/doc/DropboxApi/Faraday/Request.html new file mode 100644 index 00000000..02603ab4 --- /dev/null +++ b/doc/DropboxApi/Faraday/Request.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::Faraday::Request - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::Faraday::Request +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata.html b/doc/DropboxApi/Metadata.html new file mode 100644 index 00000000..189c1bc3 --- /dev/null +++ b/doc/DropboxApi/Metadata.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::Metadata - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::Metadata +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/AccessLevel.html b/doc/DropboxApi/Metadata/AccessLevel.html new file mode 100644 index 00000000..e93e121d --- /dev/null +++ b/doc/DropboxApi/Metadata/AccessLevel.html @@ -0,0 +1,174 @@ + + + + + + +class DropboxApi::Metadata::AccessLevel - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::AccessLevel +

+ +
+ +

Example of a serialized {AccessLevel} object:

+ +

“`json {

+ +
".tag": "viewer"
+ +

} “`

+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
VALID_ACCESS_LEVELS + +
+ + +
+
+ + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ valid_values() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/access_level.rb, line 17
+def self.valid_values
+  VALID_ACCESS_LEVELS
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/AddFileMemberResult.html b/doc/DropboxApi/Metadata/AddFileMemberResult.html new file mode 100644 index 00000000..13dfe866 --- /dev/null +++ b/doc/DropboxApi/Metadata/AddFileMemberResult.html @@ -0,0 +1,118 @@ + + + + + + +class DropboxApi::Metadata::AddFileMemberResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::AddFileMemberResult +

+ +
+ +

Example of a {AddFileMemberResult}:

+ +

“`json {

+ +
"member":{
+  ".tag": "email",
+  "email": "somebody@test.com"
+},
+"result": {
+  ".tag": "success",
+  "success": {
+    ".tag": "viewer"
+  }
+}
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/AddMember.html b/doc/DropboxApi/Metadata/AddMember.html new file mode 100644 index 00000000..be68ff14 --- /dev/null +++ b/doc/DropboxApi/Metadata/AddMember.html @@ -0,0 +1,179 @@ + + + + + + +class DropboxApi::Metadata::AddMember - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::AddMember +

+ +
+ +

Examples of serialized {AddMember} objects:

+ +

“`json {

+ +
"member": {
+  ".tag": "email",
+  "email": "justin@example.com"
+},
+"access_level": {
+  ".tag": "editor"
+}
+ +

}, {

+ +
"member": {
+  ".tag": "dropbox_id",
+  "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q"
+},
+"access_level": {
+  ".tag": "viewer"
+}
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ build_from_string(member, access_level = :editor) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/add_member.rb, line 26
+def build_from_string(member, access_level = :editor)
+  new({
+    'member' => Member.new(member),
+    'access_level' => access_level
+  })
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/Base.html b/doc/DropboxApi/Metadata/Base.html new file mode 100644 index 00000000..4e4d4975 --- /dev/null +++ b/doc/DropboxApi/Metadata/Base.html @@ -0,0 +1,320 @@ + + + + + + +class DropboxApi::Metadata::Base - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::Base +

+ +
+ +
+ + +
+ + + + + + + +
+
+

Attributes

+
+ + +
+
+ fields[R] +
+ +
+ + + +
+
+ +
+ + + +
+
+

Public Class Methods

+
+ + +
+ +
+ field(name, type, *options) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/base.rb, line 6
+def field(name, type, *options)
+  @fields ||= {}
+  @fields[name] = DropboxApi::Metadata::Field.new(type, options)
+
+  attr_reader name
+end
+
+ +
+ + + + +
+ + +
+ +
+ new(metadata) + + click to toggle source + +
+ + +
+ +

Takes in a hash containing all the attributes required to initialize the +object.

+ +

Each hash entry should have a key which identifies a field and its value, +so a valid call would be something like this:

+ +
DropboxApi::Metadata::File.new({
+  "name" => "a.jpg",
+  "path_lower" => "/a.jpg",
+  "path_display" => "/a.jpg",
+  "id" => "id:evvfE6q6cK0AAAAAAAAB2w",
+  "client_modified" => "2016-10-19T17:17:34Z",
+  "server_modified" => "2016-10-19T17:17:34Z",
+  "rev" => "28924061bdd",
+  "size" => 396317
+})
+
+ +

@raise [ArgumentError] If a required attribute is missing. @param metadata +[Hash]

+ + + + +
+
# File lib/dropbox_api/metadata/base.rb, line 33
+def initialize(metadata)
+  self.class.fields.keys.each do |field_name|
+    self[field_name] = metadata[field_name.to_s]
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ serialized_field(field_name) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/base.rb, line 45
+def serialized_field(field_name)
+  value = send field_name
+  case value
+  when Time
+    value.utc.strftime('%FT%TZ')
+  when DropboxApi::Metadata::Base
+    value.to_hash
+  else
+    value
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ to_hash() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/base.rb, line 39
+def to_hash
+  Hash[self.class.fields.keys.map do |field_name|
+    [field_name.to_s, serialized_field(field_name)]
+  end.select { |k, v| !v.nil? }]
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/BasicAccount.html b/doc/DropboxApi/Metadata/BasicAccount.html new file mode 100644 index 00000000..ec5d4896 --- /dev/null +++ b/doc/DropboxApi/Metadata/BasicAccount.html @@ -0,0 +1,126 @@ + + + + + + +class DropboxApi::Metadata::BasicAccount - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::BasicAccount +

+ +
+ +

Example of a serialized {BasicAccount} object:

+ +

“`json {

+ +
"account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
+"name": {
+    "given_name": "Franz",
+    "surname": "Ferdinand",
+    "familiar_name": "Franz",
+    "display_name": "Franz Ferdinand (Personal)"
+},
+"email": "franz@dropbox.com",
+"email_verified": true,
+"disabled": false,
+"is_teammate": true,
+"profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbid%3AAAH4f99T0taONIb-OurWxbNQ6ywGRopQngc?vers=1453416696524&size=128x128",
+"team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU",
+"root_info": {
+  root_namespace_id: 7,
+  home_namespace_id: 1,
+  home_path: "/Franz Ferdinand"
+}
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/CommitInfo.html b/doc/DropboxApi/Metadata/CommitInfo.html new file mode 100644 index 00000000..7433cca8 --- /dev/null +++ b/doc/DropboxApi/Metadata/CommitInfo.html @@ -0,0 +1,163 @@ + + + + + + +class DropboxApi::Metadata::CommitInfo - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::CommitInfo +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ build_from_options(options) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/commit_info.rb, line 10
+def build_from_options(options)
+  options = Hash[options.map do |key, value|
+    case key
+    when :mode
+      [key.to_s, build_write_mode(value)]
+    when :client_modified
+      [key.to_s, build_client_modified(value)]
+    when :path, :autorename, :mute
+      [key.to_s, value]
+    end
+  end.compact]
+
+  new(options)
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/Deleted.html b/doc/DropboxApi/Metadata/Deleted.html new file mode 100644 index 00000000..c8fba12c --- /dev/null +++ b/doc/DropboxApi/Metadata/Deleted.html @@ -0,0 +1,112 @@ + + + + + + +class DropboxApi::Metadata::Deleted - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::Deleted +

+ +
+ +

Example of a serialized {Deleted} object:

+ +

“`json {

+ +
".tag": "deleted",
+"name": "file.txt",
+"path_lower": "/file.txt",
+"path_display": "/file.txt"
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/Dimensions.html b/doc/DropboxApi/Metadata/Dimensions.html new file mode 100644 index 00000000..f4b99e3a --- /dev/null +++ b/doc/DropboxApi/Metadata/Dimensions.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Metadata::Dimensions - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::Dimensions +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/Field.html b/doc/DropboxApi/Metadata/Field.html new file mode 100644 index 00000000..0ed7676e --- /dev/null +++ b/doc/DropboxApi/Metadata/Field.html @@ -0,0 +1,254 @@ + + + + + + +class DropboxApi::Metadata::Field - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::Field +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(type, options = []) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/field.rb, line 3
+def initialize(type, options = [])
+  @type = type
+  @options = options
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ cast(object) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/field.rb, line 8
+def cast(object)
+  if object.nil?
+    raise ArgumentError unless @options.include? :optional
+    nil
+  else
+    force_cast object
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ force_cast(object) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/field.rb, line 17
+def force_cast(object)
+  if @type == String
+    object.to_s
+  elsif @type == Time
+    Time.parse(object)
+  elsif @type == Integer
+    object.to_i
+  elsif @type == Float
+    object.to_f
+  elsif @type == Symbol
+    object['.tag'].to_sym
+  elsif @type == :boolean
+    object.to_s == 'true'
+  elsif @type.ancestors.include?(DropboxApi::Metadata::Base) ||
+        @type.ancestors.include?(Array) ||
+        @type == DropboxApi::Metadata::Resource
+    @type.new(object)
+  else
+    raise NotImplementedError, "Can't cast #{object} to `#{@type}`"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/File.html b/doc/DropboxApi/Metadata/File.html new file mode 100644 index 00000000..1007e164 --- /dev/null +++ b/doc/DropboxApi/Metadata/File.html @@ -0,0 +1,178 @@ + + + + + + +class DropboxApi::Metadata::File - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::File +

+ +
+ +

Example of a serialized {File} object:

+ +

“`json {

+ +
".tag": "file",
+"name": "Prime_Numbers.txt",
+"path_lower": "/homework/math/prime_numbers.txt",
+"path_display": "/Homework/math/Prime_Numbers.txt",
+"id": "id:a4ayc_80_OEAAAAAAAAAXw",
+"client_modified": "2015-05-12T15:50:38Z",
+"server_modified": "2015-05-12T15:50:38Z",
+"rev": "a1c10ce0dd78",
+"size": 7212,
+"sharing_info": {
+  "read_only": true,
+  "parent_shared_folder_id": "84528192421",
+  "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc"
+}
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ to_hash() + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + DropboxApi::Metadata::Base#to_hash +
+ + + +
+
# File lib/dropbox_api/metadata/file.rb, line 35
+def to_hash
+  super.merge('.tag' => 'file')
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/FileCategoriesList.html b/doc/DropboxApi/Metadata/FileCategoriesList.html new file mode 100644 index 00000000..f74d6c35 --- /dev/null +++ b/doc/DropboxApi/Metadata/FileCategoriesList.html @@ -0,0 +1,157 @@ + + + + + + +class DropboxApi::Metadata::FileCategoriesList - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::FileCategoriesList +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(list) + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + +
+ + + +
+
# File lib/dropbox_api/metadata/file_categories_list.rb, line 4
+def initialize(list)
+  super(list.map { |c| DropboxApi::Metadata::FileCategory.new c })
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/FileCategory.html b/doc/DropboxApi/Metadata/FileCategory.html new file mode 100644 index 00000000..dff4e31f --- /dev/null +++ b/doc/DropboxApi/Metadata/FileCategory.html @@ -0,0 +1,166 @@ + + + + + + +class DropboxApi::Metadata::FileCategory - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::FileCategory +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
VALID_VALUES + +
+ + +
+
+ + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ valid_values() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/file_category.rb, line 17
+def self.valid_values
+  VALID_VALUES
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/FileExtensionsList.html b/doc/DropboxApi/Metadata/FileExtensionsList.html new file mode 100644 index 00000000..3d93daab --- /dev/null +++ b/doc/DropboxApi/Metadata/FileExtensionsList.html @@ -0,0 +1,161 @@ + + + + + + +class DropboxApi::Metadata::FileExtensionsList - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::FileExtensionsList +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(data) + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + +
+ + + +
+
# File lib/dropbox_api/metadata/file_extensions_list.rb, line 4
+def initialize(data)
+  if !data.is_a?(Array) || data.any? { |v| !v.is_a? String }
+    raise ArgumentError, "Invalid extension list: #{data.inspect}."
+  end
+
+  super(data)
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/FileLinkMetadata.html b/doc/DropboxApi/Metadata/FileLinkMetadata.html new file mode 100644 index 00000000..e68eed64 --- /dev/null +++ b/doc/DropboxApi/Metadata/FileLinkMetadata.html @@ -0,0 +1,134 @@ + + + + + + +class DropboxApi::Metadata::FileLinkMetadata - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::FileLinkMetadata +

+ +
+ +

Example of a serialized {FileLinkMetadata} object:

+ +

“`json {

+ +
".tag": "file",
+"url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0",
+"name": "Prime_Numbers.txt",
+"link_permissions": {
+  "can_revoke": false,
+  "resolved_visibility": {
+    ".tag": "public"
+  },
+  "revoke_failure_reason": {
+    ".tag": "owner_only"
+  }
+},
+"client_modified": "2015-05-12T15:50:38Z",
+"server_modified": "2015-05-12T15:50:38Z",
+"rev": "a1c10ce0dd78",
+"size": 7212,
+"id": "id:a4ayc_80_OEAAAAAAAAAXw",
+"path_lower": "/homework/math/prime_numbers.txt",
+"team_member_info": {
+  "team_info": {
+    "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
+    "name": "Acme, Inc."
+  },
+  "display_name": "Roger Rabbit",
+  "member_id": "dbmid:abcd1234"
+}
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/FileMemberAction.html b/doc/DropboxApi/Metadata/FileMemberAction.html new file mode 100644 index 00000000..5a9425e9 --- /dev/null +++ b/doc/DropboxApi/Metadata/FileMemberAction.html @@ -0,0 +1,164 @@ + + + + + + +class DropboxApi::Metadata::FileMemberAction - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::FileMemberAction +

+ +
+ +

Example of a serialized FileMemberAction:

+ +

“`json {

+ +
".tag": "success",
+"success": {
+  ".tag": "viewer"
+}
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/file_member_action.rb, line 14
+def new(data)
+  tag = data['.tag']
+  class_for(tag.to_sym).new(data[tag])
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/FileRequest.html b/doc/DropboxApi/Metadata/FileRequest.html new file mode 100644 index 00000000..46e2cfc1 --- /dev/null +++ b/doc/DropboxApi/Metadata/FileRequest.html @@ -0,0 +1,121 @@ + + + + + + +class DropboxApi::Metadata::FileRequest - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::FileRequest +

+ +
+ +

Example of a serialized {FileRequest} object:

+ +

“`json {

+ +
"id": "oaCAVmEyrqYnkZX9955Y",
+"url": "https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y",
+"title": "Homework submission",
+"created": "2015-10-05T17:00:00Z",
+"is_open": true,
+"file_count": 3,
+"destination": "/File Requests/Homework",
+"deadline": {
+    "deadline": "2020-10-12T17:00:00Z",
+    "allow_late_uploads": {
+        ".tag": "seven_days"
+    }
+}
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/FileStatus.html b/doc/DropboxApi/Metadata/FileStatus.html new file mode 100644 index 00000000..76076237 --- /dev/null +++ b/doc/DropboxApi/Metadata/FileStatus.html @@ -0,0 +1,166 @@ + + + + + + +class DropboxApi::Metadata::FileStatus - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::FileStatus +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
VALID_VALUES + +
+ + +
+
+ + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ valid_values() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/file_status.rb, line 9
+def self.valid_values
+  VALID_VALUES
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/Folder.html b/doc/DropboxApi/Metadata/Folder.html new file mode 100644 index 00000000..39227357 --- /dev/null +++ b/doc/DropboxApi/Metadata/Folder.html @@ -0,0 +1,168 @@ + + + + + + +class DropboxApi::Metadata::Folder - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::Folder +

+ +
+ +

Example of a serialized {Folder} object:

+ +

“`json {

+ +
"name": "arizona_baby",
+"path_lower": "/arizona_baby",
+"path_display": "/arizona_baby",
+"id": "id:7eWkV5hcfzAAAAAAAAAAAQ"
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ to_hash() + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + DropboxApi::Metadata::Base#to_hash +
+ + + +
+
# File lib/dropbox_api/metadata/folder.rb, line 19
+def to_hash
+  super.merge('.tag' => 'folder')
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/FolderLinkMetadata.html b/doc/DropboxApi/Metadata/FolderLinkMetadata.html new file mode 100644 index 00000000..3b71fbb1 --- /dev/null +++ b/doc/DropboxApi/Metadata/FolderLinkMetadata.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Metadata::FolderLinkMetadata - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::FolderLinkMetadata +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/FolderSharingInfo.html b/doc/DropboxApi/Metadata/FolderSharingInfo.html new file mode 100644 index 00000000..b5c727d4 --- /dev/null +++ b/doc/DropboxApi/Metadata/FolderSharingInfo.html @@ -0,0 +1,110 @@ + + + + + + +class DropboxApi::Metadata::FolderSharingInfo - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::FolderSharingInfo +

+ +
+ +

Example of a serialized {FolderSharingInfo} object:

+ +

“`json {

+ +
"read_only": false,
+"parent_shared_folder_id": "84528192421"
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/LinkPermissions.html b/doc/DropboxApi/Metadata/LinkPermissions.html new file mode 100644 index 00000000..c48d12c6 --- /dev/null +++ b/doc/DropboxApi/Metadata/LinkPermissions.html @@ -0,0 +1,115 @@ + + + + + + +class DropboxApi::Metadata::LinkPermissions - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::LinkPermissions +

+ +
+ +

Example of a serialized {LinkPermissions} object:

+ +

“`json {

+ +
"can_revoke": false,
+"resolved_visibility": {
+  ".tag": "public"
+},
+"revoke_failure_reason": {
+  ".tag": "owner_only"
+}
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/Location.html b/doc/DropboxApi/Metadata/Location.html new file mode 100644 index 00000000..37b1297c --- /dev/null +++ b/doc/DropboxApi/Metadata/Location.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Metadata::Location - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::Location +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/MediaInfo.html b/doc/DropboxApi/Metadata/MediaInfo.html new file mode 100644 index 00000000..24c69257 --- /dev/null +++ b/doc/DropboxApi/Metadata/MediaInfo.html @@ -0,0 +1,175 @@ + + + + + + +class DropboxApi::Metadata::MediaInfo - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::MediaInfo +

+ +
+ +

Example of a serialized {MediaInfo} object:

+ +

“`json {

+ +
".tag": "metadata",
+"metadata": {...}
+ +

} “`

+ +

or:

+ +

“`json {

+ +
".tag": "pending"
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/media_info.rb, line 20
+def new(data)
+  klass = class_for(data['.tag'].to_sym)
+
+  if klass == :pending
+    :pending
+  else
+    klass.new(data['metadata'])
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/MediaMetadata.html b/doc/DropboxApi/Metadata/MediaMetadata.html new file mode 100644 index 00000000..12b4bf1f --- /dev/null +++ b/doc/DropboxApi/Metadata/MediaMetadata.html @@ -0,0 +1,171 @@ + + + + + + +class DropboxApi::Metadata::MediaMetadata - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::MediaMetadata +

+ +
+ +

Example of a serialized {MediaInfo} object:

+ +

“`json {

+ +
".tag": "video",
+"dimensions": {
+  "height": 1500,
+  "width": 1500
+},
+"location": {
+  "latitude": 10.123456,
+  "longitude": 5.123456
+}
+"time_taken": "2016-09-04T17:00:27Z",
+"duration": 6000
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/media_metadata.rb, line 21
+def new(data)
+  tag = data['.tag']
+  class_for(tag.to_sym).new(data)
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/Member.html b/doc/DropboxApi/Metadata/Member.html new file mode 100644 index 00000000..5aaeb980 --- /dev/null +++ b/doc/DropboxApi/Metadata/Member.html @@ -0,0 +1,218 @@ + + + + + + +class DropboxApi::Metadata::Member - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::Member +

+ +
+ +

Examples of serialized {AddMember} objects:

+ +

“`json [

+ +
{
+  ".tag": "email",
+  "email": "justin@example.com"
+},  {
+  ".tag": "dropbox_id",
+  "dropbox_id": "dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q"
+}
+ +

] “`

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(member) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/member.rb, line 16
+def initialize(member)
+  @member_hash = case member
+    when Hash
+      member
+    when String
+      hash_from_email_or_dropbox_id member
+    when DropboxApi::Metadata::Member
+      member.to_hash
+    else
+      raise ArgumentError, "Invalid object for Member: #{member.inspect}"
+    end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ to_hash() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/member.rb, line 29
+def to_hash
+  @member_hash
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/MemberAction.html b/doc/DropboxApi/Metadata/MemberAction.html new file mode 100644 index 00000000..67bf4e3e --- /dev/null +++ b/doc/DropboxApi/Metadata/MemberAction.html @@ -0,0 +1,191 @@ + + + + + + +class DropboxApi::Metadata::MemberAction - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::MemberAction +

+ +
+ +

An action will be one of the following:

+
  • +

    `:leave_a_copy`: Allow the member to keep a copy of the folder when +removing.

    +
  • +

    `:make_editor`: Make the member an editor of the folder.

    +
  • +

    `:make_owner`: Make the member an owner of the folder.

    +
  • +

    `:make_viewer`: Make the member a viewer of the folder.

    +
  • +

    `:make_viewer_no_comment`: Make the member a viewer of the folder without +commenting permissions.

    +
  • +

    `:remove`: Remove the member from the folder.

    +
+ +

Example of a serialized {MemberAction} object:

+ +

“`json {

+ +
".tag": "leave_a_copy"
+ +

} “`

+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
VALID_MEMBER_ACTIONS + +
+ + +
+
+ + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ valid_values() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/member_action.rb, line 30
+def self.valid_values
+  VALID_MEMBER_ACTIONS
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/MemberActionList.html b/doc/DropboxApi/Metadata/MemberActionList.html new file mode 100644 index 00000000..ecccf680 --- /dev/null +++ b/doc/DropboxApi/Metadata/MemberActionList.html @@ -0,0 +1,165 @@ + + + + + + +class DropboxApi::Metadata::MemberActionList - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::MemberActionList +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(list) + + click to toggle source + +
+ + +
+ +

Builds a list of actions for a shared folder.

+ +

@example

+ +
DropboxApi::Metadata::MemberActionList.new([:leave_a_copy, :make_editor])
+# => [:leave_a_copy, :make_editor]
+
+ +

@see Metadata::MemberAction

+ + +
+ Calls superclass method + +
+ + + +
+
# File lib/dropbox_api/metadata/member_action_list.rb, line 9
+def initialize(list)
+  super(list.map { |a| DropboxApi::Metadata::MemberAction.new a })
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/MemberPermission.html b/doc/DropboxApi/Metadata/MemberPermission.html new file mode 100644 index 00000000..2c77c25d --- /dev/null +++ b/doc/DropboxApi/Metadata/MemberPermission.html @@ -0,0 +1,117 @@ + + + + + + +class DropboxApi::Metadata::MemberPermission - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::MemberPermission +

+ +
+ +

This is an example of a serialized {MemberPermission}:

+ +

“`json {

+ +
"action": {
+  ".tag": "remove"
+},
+"allow": false,
+"reason": {
+  ".tag": "target_is_self"
+}
+ +

} “`

+ +

This is normally contained in a {MemberPermissionList} object.

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/MemberPermissionList.html b/doc/DropboxApi/Metadata/MemberPermissionList.html new file mode 100644 index 00000000..9627db96 --- /dev/null +++ b/doc/DropboxApi/Metadata/MemberPermissionList.html @@ -0,0 +1,182 @@ + + + + + + +class DropboxApi::Metadata::MemberPermissionList - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::MemberPermissionList +

+ +
+ +

This represents a collection of permissions on allowed on a shared file or +folder.

+ +

This is an example of a serialized {MemberActionList}: “`json [{

+ +
"action": {
+  ".tag": "remove"
+},
+"allow": false,
+"reason": {
+  ".tag": "target_is_self"
+}
+ +

}, {

+ +
"action": {
+  ".tag": "make_owner"
+},
+"allow": false,
+"reason": {
+  ".tag": "target_is_self"
+}
+ +

}] “`

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(list) + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + +
+ + + +
+
# File lib/dropbox_api/metadata/member_permission_list.rb, line 26
+def initialize(list)
+  super(list.map { |i| DropboxApi::Metadata::MemberPermission.new i })
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/MetadataV2.html b/doc/DropboxApi/Metadata/MetadataV2.html new file mode 100644 index 00000000..e2a6d92f --- /dev/null +++ b/doc/DropboxApi/Metadata/MetadataV2.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Metadata::MetadataV2 - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::MetadataV2 +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/Name.html b/doc/DropboxApi/Metadata/Name.html new file mode 100644 index 00000000..dadff6f0 --- /dev/null +++ b/doc/DropboxApi/Metadata/Name.html @@ -0,0 +1,112 @@ + + + + + + +class DropboxApi::Metadata::Name - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::Name +

+ +
+ +

Example of a serialized {Name} object:

+ +

“`json {

+ +
"given_name": "Franz",
+"surname": "Ferdinand",
+"familiar_name": "Franz",
+"display_name": "Franz Ferdinand (Personal)"
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/NamespaceId.html b/doc/DropboxApi/Metadata/NamespaceId.html new file mode 100644 index 00000000..af63a36e --- /dev/null +++ b/doc/DropboxApi/Metadata/NamespaceId.html @@ -0,0 +1,157 @@ + + + + + + +class DropboxApi::Metadata::NamespaceId - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::NamespaceId +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ to_hash() + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + DropboxApi::Metadata::Base#to_hash +
+ + + +
+
# File lib/dropbox_api/metadata/namespace_id.rb, line 5
+def to_hash
+  super.merge({".tag": 'namespace_id'})
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/ParentFolderAccessInfo.html b/doc/DropboxApi/Metadata/ParentFolderAccessInfo.html new file mode 100644 index 00000000..f3b6e89c --- /dev/null +++ b/doc/DropboxApi/Metadata/ParentFolderAccessInfo.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Metadata::ParentFolderAccessInfo - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::ParentFolderAccessInfo +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/PhotoMetadata.html b/doc/DropboxApi/Metadata/PhotoMetadata.html new file mode 100644 index 00000000..365c9fc1 --- /dev/null +++ b/doc/DropboxApi/Metadata/PhotoMetadata.html @@ -0,0 +1,118 @@ + + + + + + +class DropboxApi::Metadata::PhotoMetadata - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::PhotoMetadata +

+ +
+ +

Example of a serialized {PhotoMetadata} object:

+ +

“`json {

+ +
".tag": "photo",
+"dimensions": {
+  "height": 1500,
+  "width": 1500
+},
+"location": {
+  "latitude": 10.123456,
+  "longitude": 5.123456
+}
+"time_taken": "2016-09-04T17:00:27Z"
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/Resource.html b/doc/DropboxApi/Metadata/Resource.html new file mode 100644 index 00000000..d8ce31ec --- /dev/null +++ b/doc/DropboxApi/Metadata/Resource.html @@ -0,0 +1,160 @@ + + + + + + +class DropboxApi::Metadata::Resource - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::Resource +

+ +
+ +

This class is used as an adapter so we can create an object of the +pertinent class when we need to infer the type from the data.

+ +

For example, calling `Resource.new({“.tag” => “file”, :name => …})` +will instantiate a `File` object.

+ +

So this could initalize an object of either `File`, `Folder` or `Deleted`.

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/resource.rb, line 11
+def new(data)
+  class_for(data['.tag'].to_sym).new(data)
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/RootInfo.html b/doc/DropboxApi/Metadata/RootInfo.html new file mode 100644 index 00000000..eb4d5063 --- /dev/null +++ b/doc/DropboxApi/Metadata/RootInfo.html @@ -0,0 +1,162 @@ + + + + + + +class DropboxApi::Metadata::RootInfo - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::RootInfo +

+ +
+ +

Example of a serialized {RootInfo} object:

+ +

“`json {

+ +
".tag":"user",
+"root_namespace_id":"42",
+"home_namespace_id":"42"
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/root_info.rb, line 13
+def new(data)
+  class_for(data['.tag'].to_sym).new(data)
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/SearchMatchFieldOptions.html b/doc/DropboxApi/Metadata/SearchMatchFieldOptions.html new file mode 100644 index 00000000..c2efd969 --- /dev/null +++ b/doc/DropboxApi/Metadata/SearchMatchFieldOptions.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Metadata::SearchMatchFieldOptions - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::SearchMatchFieldOptions +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/SearchMatchTypeV2.html b/doc/DropboxApi/Metadata/SearchMatchTypeV2.html new file mode 100644 index 00000000..1d99ef9a --- /dev/null +++ b/doc/DropboxApi/Metadata/SearchMatchTypeV2.html @@ -0,0 +1,166 @@ + + + + + + +class DropboxApi::Metadata::SearchMatchTypeV2 - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::SearchMatchTypeV2 +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
VALID_VALUES + +
+ + +
+
+ + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ valid_values() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/search_match_type_v2.rb, line 11
+def self.valid_values
+  VALID_VALUES
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/SearchMatchV2.html b/doc/DropboxApi/Metadata/SearchMatchV2.html new file mode 100644 index 00000000..b920434c --- /dev/null +++ b/doc/DropboxApi/Metadata/SearchMatchV2.html @@ -0,0 +1,155 @@ + + + + + + +class DropboxApi::Metadata::SearchMatchV2 - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::SearchMatchV2 +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ resource() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/search_match_v2.rb, line 10
+def resource
+  # for some strange reason, v2 of this search endpoint doesn't have
+  # the `resource` field anymore and file metadata is wrapped in a
+  # metadata/metadata field...
+  metadata.metadata
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/SearchOptions.html b/doc/DropboxApi/Metadata/SearchOptions.html new file mode 100644 index 00000000..db1df3d3 --- /dev/null +++ b/doc/DropboxApi/Metadata/SearchOptions.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Metadata::SearchOptions - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::SearchOptions +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/SearchOrderBy.html b/doc/DropboxApi/Metadata/SearchOrderBy.html new file mode 100644 index 00000000..f60b2acb --- /dev/null +++ b/doc/DropboxApi/Metadata/SearchOrderBy.html @@ -0,0 +1,166 @@ + + + + + + +class DropboxApi::Metadata::SearchOrderBy - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::SearchOrderBy +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
VALID_VALUES + +
+ + +
+
+ + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ valid_values() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/search_order_by.rb, line 9
+def self.valid_values
+  VALID_VALUES
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/SharedFolder.html b/doc/DropboxApi/Metadata/SharedFolder.html new file mode 100644 index 00000000..d06f66af --- /dev/null +++ b/doc/DropboxApi/Metadata/SharedFolder.html @@ -0,0 +1,119 @@ + + + + + + +class DropboxApi::Metadata::SharedFolder - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::SharedFolder +

+ +
+ +

Example of a serialized {SharedFolder} object:

+ +

“`json {

+ +
".tag" => "complete",
+"access_type" => {".tag"=>"owner"},
+"is_team_folder" => false,
+"policy" => {
+  "acl_update_policy" => { ".tag" => "owner" },
+  "shared_link_policy" => { ".tag" => "anyone" }
+},
+"path_lower" => "/folder_a",
+"name" => "folder_a",
+"shared_folder_id" => "1231266557",
+"time_invited" => "2016-06-04T10:00:35Z"
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/SharedFolderPolicy.html b/doc/DropboxApi/Metadata/SharedFolderPolicy.html new file mode 100644 index 00000000..04c0171d --- /dev/null +++ b/doc/DropboxApi/Metadata/SharedFolderPolicy.html @@ -0,0 +1,110 @@ + + + + + + +class DropboxApi::Metadata::SharedFolderPolicy - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::SharedFolderPolicy +

+ +
+ +

Example of a serialized {SharedFolderPolicy} object:

+ +

“`json {

+ +
"acl_update_policy" => { ".tag" => "owner" },
+"shared_link_policy" => { ".tag" => "anyone" }
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/SharedLink.html b/doc/DropboxApi/Metadata/SharedLink.html new file mode 100644 index 00000000..61ad9a42 --- /dev/null +++ b/doc/DropboxApi/Metadata/SharedLink.html @@ -0,0 +1,260 @@ + + + + + + +class DropboxApi::Metadata::SharedLink - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::SharedLink +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
VALID_KEYS + +
+ + +
+
+ + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(param) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/shared_link.rb, line 5
+def initialize(param)
+  @shared_link =
+    case param
+    when String
+      {url: param}
+    when Hash
+      param
+    end
+
+  check_validity
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ check_validity() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/shared_link.rb, line 17
+def check_validity
+  if @shared_link[:url].nil?
+    raise ArgumentError, 'Missing `:url` option'
+  end
+
+  @shared_link.keys.each do |key|
+    unless VALID_KEYS.include? key
+      raise ArgumentError, "Invalid option `#{key.inspect}`"
+    end
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ to_hash() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/shared_link.rb, line 29
+def to_hash
+  @shared_link
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/SharedLinkMetadata.html b/doc/DropboxApi/Metadata/SharedLinkMetadata.html new file mode 100644 index 00000000..5d731d11 --- /dev/null +++ b/doc/DropboxApi/Metadata/SharedLinkMetadata.html @@ -0,0 +1,157 @@ + + + + + + +class DropboxApi::Metadata::SharedLinkMetadata - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::SharedLinkMetadata +

+ +
+ +

This class is used as an adapter so we can create an object of the +pertinent class when we need to infer the type from the data.

+ +

This same pattern is used in `DropboxApi::Metadata::Resource`

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/shared_link_metadata.rb, line 8
+def new(data)
+  class_for(data['.tag'].to_sym).new(data)
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/SpaceAllocation.html b/doc/DropboxApi/Metadata/SpaceAllocation.html new file mode 100644 index 00000000..486ee763 --- /dev/null +++ b/doc/DropboxApi/Metadata/SpaceAllocation.html @@ -0,0 +1,110 @@ + + + + + + +class DropboxApi::Metadata::SpaceAllocation - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::SpaceAllocation +

+ +
+ +

Example of a serialized {SpaceAllocation} object:

+ +

“`json {

+ +
".tag": "individual",
+"allocated": 2147483648
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/SpaceUsage.html b/doc/DropboxApi/Metadata/SpaceUsage.html new file mode 100644 index 00000000..868f75ae --- /dev/null +++ b/doc/DropboxApi/Metadata/SpaceUsage.html @@ -0,0 +1,113 @@ + + + + + + +class DropboxApi::Metadata::SpaceUsage - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::SpaceUsage +

+ +
+ +

Example of a serialized {SpaceUsage} object:

+ +

“`json {

+ +
"used": 167685342,
+"allocation": {
+  ".tag": "individual",
+  "allocated": 2147483648
+}
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/Tag.html b/doc/DropboxApi/Metadata/Tag.html new file mode 100644 index 00000000..28713aca --- /dev/null +++ b/doc/DropboxApi/Metadata/Tag.html @@ -0,0 +1,200 @@ + + + + + + +class DropboxApi::Metadata::Tag - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::Tag +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/tag.rb, line 3
+def self.new(data)
+  case data
+  when ::Symbol
+    validate(data)
+  when Hash
+    new(data['.tag'].to_sym)
+  when String
+    new(data.to_sym)
+  else
+    raise ArgumentError, "Invalid object for #{name}: #{data.inspect}."
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ validate(value) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/tag.rb, line 16
+def self.validate(value)
+  if valid_values.include? value
+    value
+  else
+    raise ArgumentError, "Invalid value for #{name}: #{value.inspect}"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/Team.html b/doc/DropboxApi/Metadata/Team.html new file mode 100644 index 00000000..c9b61c76 --- /dev/null +++ b/doc/DropboxApi/Metadata/Team.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Metadata::Team - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::Team +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/TeamMemberInfo.html b/doc/DropboxApi/Metadata/TeamMemberInfo.html new file mode 100644 index 00000000..8a661486 --- /dev/null +++ b/doc/DropboxApi/Metadata/TeamMemberInfo.html @@ -0,0 +1,114 @@ + + + + + + +class DropboxApi::Metadata::TeamMemberInfo - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::TeamMemberInfo +

+ +
+ +

Example of a serialized {TeamMemberInfo} object:

+ +

“`json {

+ +
"team_info": {
+  "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
+  "name": "Acme, Inc."
+},
+"display_name": "Roger Rabbit",
+"member_id": "dbmid:abcd1234"
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/TeamRootInfo.html b/doc/DropboxApi/Metadata/TeamRootInfo.html new file mode 100644 index 00000000..42013580 --- /dev/null +++ b/doc/DropboxApi/Metadata/TeamRootInfo.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Metadata::TeamRootInfo - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::TeamRootInfo +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/ThumbnailBatchResultData.html b/doc/DropboxApi/Metadata/ThumbnailBatchResultData.html new file mode 100644 index 00000000..6b85fd0c --- /dev/null +++ b/doc/DropboxApi/Metadata/ThumbnailBatchResultData.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Metadata::ThumbnailBatchResultData - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::ThumbnailBatchResultData +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/ThumbnailBatchResultEntry.html b/doc/DropboxApi/Metadata/ThumbnailBatchResultEntry.html new file mode 100644 index 00000000..6b5d5c9c --- /dev/null +++ b/doc/DropboxApi/Metadata/ThumbnailBatchResultEntry.html @@ -0,0 +1,167 @@ + + + + + + +class DropboxApi::Metadata::ThumbnailBatchResultEntry - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::ThumbnailBatchResultEntry +

+ +
+ +

This class is used as an adapter so we can create an object of the +pertinent class when we need to infer the type from the data.

+ +

This same pattern is used in `DropboxApi::Metadata::Resource`

+ +

So this could initalize an object of either `ThumbnailBatchResultData` or +`ThumbnailError`.

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb, line 11
+def new(data)
+  case data['.tag'].to_sym
+  when :success
+    DropboxApi::Metadata::ThumbnailBatchResultData.new(data)
+  when :failure
+    DropboxApi::Errors::ThumbnailError.build('Thumbnail generation failed', data['failure'])
+  else
+    raise NotImplementedError, "Unknown result type: #{data[".tag"]}"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/UploadSessionCursor.html b/doc/DropboxApi/Metadata/UploadSessionCursor.html new file mode 100644 index 00000000..2c410727 --- /dev/null +++ b/doc/DropboxApi/Metadata/UploadSessionCursor.html @@ -0,0 +1,161 @@ + + + + + + +class DropboxApi::Metadata::UploadSessionCursor - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::UploadSessionCursor +

+ +
+ +

Example of a serialized {UploadSessionCursor} object:

+ +

“`json {

+ +
"session_id": "AAAAAAAABCJ61k9yZZtn8Q",
+"offset":9
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ offset=(n) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/upload_session_cursor.rb, line 14
+def offset=(n)
+  self[:offset] = n
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/UserRootInfo.html b/doc/DropboxApi/Metadata/UserRootInfo.html new file mode 100644 index 00000000..905c8504 --- /dev/null +++ b/doc/DropboxApi/Metadata/UserRootInfo.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Metadata::UserRootInfo - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::UserRootInfo +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/VideoMetadata.html b/doc/DropboxApi/Metadata/VideoMetadata.html new file mode 100644 index 00000000..a0dbfdb7 --- /dev/null +++ b/doc/DropboxApi/Metadata/VideoMetadata.html @@ -0,0 +1,119 @@ + + + + + + +class DropboxApi::Metadata::VideoMetadata - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::VideoMetadata +

+ +
+ +

Example of a serialized {MediaInfo} object:

+ +

“`json {

+ +
".tag": "video",
+"dimensions": {
+  "height": 1500,
+  "width": 1500
+},
+"location": {
+  "latitude": 10.123456,
+  "longitude": 5.123456
+}
+"time_taken": "2016-09-04T17:00:27Z",
+"duration": 6000
+ +

} “`

+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Metadata/WriteMode.html b/doc/DropboxApi/Metadata/WriteMode.html new file mode 100644 index 00000000..13edf700 --- /dev/null +++ b/doc/DropboxApi/Metadata/WriteMode.html @@ -0,0 +1,310 @@ + + + + + + +class DropboxApi::Metadata::WriteMode - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Metadata::WriteMode +

+ +
+ +

Your intent when writing a file to some path. This is used to determine +what constitutes a conflict and what the autorename strategy is.

+ +

In some situations, the conflict behavior is identical:

+ +
- If the target path doesn't contain anything, the file is always
+  written; no conflict.
+- If the target path contains a folder, it's always a conflict.
+- If the target path contains a file with identical contents, nothing
+  gets written; no conflict.
+ +

The conflict checking differs in the case where there's a file at the +target path with contents different from the contents you're trying to +write. The value will be one of the following datatypes:

+
  • +

    `:add`: Do not overwrite an existing file if there is a conflict. The +autorename strategy is to append a number to the file name. For example, +“document.txt” might become “document (2).txt”.

    +
  • +

    `:overwrite`: Always overwrite the existing file. The autorename strategy +is the same as it is for add.

    +
  • +

    `:update`: Overwrite if the given “rev” matches the existing file's +“rev”. The autorename strategy is to append the string “conflicted copy” to +the file name. For example, “document.txt” might become “document +(conflicted copy).txt” or “document (Panda's conflicted copy).txt”.

    +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
VALID_WRITE_MODES + +
+ + +
+
+ + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(write_mode, options = nil) + + click to toggle source + +
+ + +
+ +

@example

+ +
DropboxApi::Metadata::WriteMode.new :add
+
+ +

@example

+ +
DropboxApi::Metadata::WriteMode.new :overwrite
+
+ +

@example

+ +
DropboxApi::Metadata::WriteMode.new :update, "a1c10ce0dd78"
+
+ +

@example

+ +
DropboxApi::Metadata::WriteMode.new({
+  ".tag"=>"update",
+  "update"=>"a1c10ce0dd78"
+})
+
+ + + + +
+
# File lib/dropbox_api/metadata/write_mode.rb, line 45
+def initialize(write_mode, options = nil)
+  case write_mode
+  when Hash
+    @write_mode = write_mode
+  when String, ::Symbol
+    @write_mode = {
+      '.tag' => write_mode
+    }
+    @write_mode[write_mode.to_s] = options unless options.nil?
+  end
+  @write_mode['.tag'] = @write_mode['.tag'].to_sym
+
+  check_validity
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ check_validity() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/write_mode.rb, line 60
+def check_validity
+  unless valid_mode? @write_mode['.tag']
+    raise ArgumentError, "Invalid write mode: #{@write_mode[".tag"]}"
+  end
+
+  if @write_mode['.tag'] == :update && @write_mode['update'].nil?
+    raise ArgumentError, 'Mode `:update` expects a `rev` number'
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ to_hash() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/metadata/write_mode.rb, line 70
+def to_hash
+  @write_mode
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/MiddleWare.html b/doc/DropboxApi/MiddleWare.html new file mode 100644 index 00000000..2e3ecb4a --- /dev/null +++ b/doc/DropboxApi/MiddleWare.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::MiddleWare - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::MiddleWare +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/MiddleWare/DecodeResult.html b/doc/DropboxApi/MiddleWare/DecodeResult.html new file mode 100644 index 00000000..652c8672 --- /dev/null +++ b/doc/DropboxApi/MiddleWare/DecodeResult.html @@ -0,0 +1,200 @@ + + + + + + +class DropboxApi::MiddleWare::DecodeResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::MiddleWare::DecodeResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ call(rq_env) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/middleware/decode_result.rb, line 3
+def call(rq_env)
+  @app.call(rq_env).on_complete do |rs_env|
+    if !rs_env[:response_headers]['Dropbox-Api-Result'].nil?
+      rs_env[:api_result] = decode rs_env[:response_headers]['Dropbox-Api-Result']
+    elsif rs_env[:response_headers]['content-type'] == 'application/json'
+      rs_env[:api_result] = decode rs_env[:body]
+    end
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ decode(json) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/middleware/decode_result.rb, line 13
+def decode(json)
+  # Dropbox may send a response with the string 'null' in its body, this
+  # would be a void result. `add_folder_member` is an example of an
+  # endpoint without return values.
+  if json == 'null'
+    {}
+  else
+    JSON.parse json
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/MiddleWare/Faraday.html b/doc/DropboxApi/MiddleWare/Faraday.html new file mode 100644 index 00000000..4e7c9942 --- /dev/null +++ b/doc/DropboxApi/MiddleWare/Faraday.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::MiddleWare::Faraday - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::MiddleWare::Faraday +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/MiddleWare/PathRoot.html b/doc/DropboxApi/MiddleWare/PathRoot.html new file mode 100644 index 00000000..eaa693c6 --- /dev/null +++ b/doc/DropboxApi/MiddleWare/PathRoot.html @@ -0,0 +1,297 @@ + + + + + + +class DropboxApi::MiddleWare::PathRoot - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::MiddleWare::PathRoot +

+ +
+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
HEADER_NAME + +
+ + +
+
+ + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(app, options = {}) + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + +
+ + + +
+
# File lib/dropbox_api/middleware/path_root.rb, line 5
+def initialize(app, options = {})
+  super(app)
+  @options = options
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ call(env) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/middleware/path_root.rb, line 26
+def call(env)
+  if !namespace_id.nil?
+    env[:request_headers][HEADER_NAME] ||= namespace_id_header_value
+  end
+
+  @app.call env
+end
+
+ +
+ + + + +
+ + +
+ +
+ namespace_id() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/middleware/path_root.rb, line 10
+def namespace_id
+  if @options[:namespace_id].nil?
+    return nil
+  else
+    return @options[:namespace_id]
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ namespace_id_header_value() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/middleware/path_root.rb, line 18
+def namespace_id_header_value
+  JSON.dump(
+    DropboxApi::Metadata::NamespaceId.new({
+      'namespace_id' => namespace_id
+    }).to_hash
+  )
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/MiddleWare/Stack.html b/doc/DropboxApi/MiddleWare/Stack.html new file mode 100644 index 00000000..4844d0bf --- /dev/null +++ b/doc/DropboxApi/MiddleWare/Stack.html @@ -0,0 +1,305 @@ + + + + + + +class DropboxApi::MiddleWare::Stack - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::MiddleWare::Stack +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/middleware/stack.rb, line 3
+def initialize
+  @prependable, @appendable = [], []
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ adapter=(value) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/middleware/stack.rb, line 15
+def adapter=(value)
+  @adapter = value
+end
+
+ +
+ + + + +
+ + +
+ +
+ append(&block) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/middleware/stack.rb, line 11
+def append(&block)
+  @appendable << block
+end
+
+ +
+ + + + +
+ + +
+ +
+ apply(connection) { |connection| ... } + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/middleware/stack.rb, line 19
+def apply(connection)
+  @prependable.each { |block| block.yield(connection) }
+  yield connection
+  @appendable.each { |block| block.yield(connection) }
+
+  # Adapter must be the last middleware configured
+  connection.adapter(@adapter || Faraday.default_adapter)
+end
+
+ +
+ + + + +
+ + +
+ +
+ prepend(&block) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/middleware/stack.rb, line 7
+def prepend(&block)
+  @prependable << block
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/OAuth2.html b/doc/DropboxApi/OAuth2.html new file mode 100644 index 00000000..44734a23 --- /dev/null +++ b/doc/DropboxApi/OAuth2.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::OAuth2 - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::OAuth2 +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/OptionsValidator.html b/doc/DropboxApi/OptionsValidator.html new file mode 100644 index 00000000..a252b4fc --- /dev/null +++ b/doc/DropboxApi/OptionsValidator.html @@ -0,0 +1,153 @@ + + + + + + +module DropboxApi::OptionsValidator - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::OptionsValidator +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ validate_options(valid_option_keys, options) + + click to toggle source + +
+ + +
+ +

Takes in a list of valid option keys and a hash of options. If one of the +keys in the hash is invalid an ArgumentError will be raised.

+ +

@param valid_option_keys List of valid keys for the options hash. @param +options [Hash] Options hash.

+ + + + +
+
# File lib/dropbox_api/options_validator.rb, line 8
+def validate_options(valid_option_keys, options)
+  options.keys.each do |key|
+    unless valid_option_keys.include? key.to_sym
+      raise ArgumentError, "Invalid option `#{key}`"
+    end
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/ResultBuilder.html b/doc/DropboxApi/ResultBuilder.html new file mode 100644 index 00000000..770299bc --- /dev/null +++ b/doc/DropboxApi/ResultBuilder.html @@ -0,0 +1,370 @@ + + + + + + +class DropboxApi::ResultBuilder - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::ResultBuilder +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(response_data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/result_builder.rb, line 3
+def initialize(response_data)
+  @response_data = response_data
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ build(result_class) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/result_builder.rb, line 23
+def build(result_class)
+  result_class.new(@response_data)
+end
+
+ +
+ + + + +
+ + +
+ +
+ build_error(error_type) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/result_builder.rb, line 27
+def build_error(error_type)
+  error_type.build(error_summary, error)
+end
+
+ +
+ + + + +
+ + +
+ +
+ error() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/result_builder.rb, line 11
+def error
+  @response_data['error']
+end
+
+ +
+ + + + +
+ + +
+ +
+ error_summary() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/result_builder.rb, line 7
+def error_summary
+  @response_data['error_summary'] if @response_data.is_a? Hash
+end
+
+ +
+ + + + +
+ + +
+ +
+ has_error?() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/result_builder.rb, line 15
+def has_error?
+  !error_summary.nil?
+end
+
+ +
+ + + + +
+ + +
+ +
+ success?() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/result_builder.rb, line 19
+def success?
+  !has_error?
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results.html b/doc/DropboxApi/Results.html new file mode 100644 index 00000000..2db2f1c8 --- /dev/null +++ b/doc/DropboxApi/Results.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::Results - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::Results +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Results/AddFileMemberResultList.html b/doc/DropboxApi/Results/AddFileMemberResultList.html new file mode 100644 index 00000000..d4e10da9 --- /dev/null +++ b/doc/DropboxApi/Results/AddFileMemberResultList.html @@ -0,0 +1,173 @@ + + + + + + +class DropboxApi::Results::AddFileMemberResultList - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::AddFileMemberResultList +

+ +
+ +

Example of a result of the `add_file_member` endpoint:

+ +
[{
+  "member":{
+    ".tag": "email",
+    "email": "somebody@test.com"
+  },
+  "result": {
+    ".tag": "success",
+    "success": {
+      ".tag": "viewer"
+    }
+  }
+}]
+
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(members) + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + +
+ + + +
+
# File lib/dropbox_api/results/add_file_member_result_list.rb, line 16
+def initialize(members)
+  super(members.map { |m| DropboxApi::Metadata::AddFileMemberResult.new m })
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/Base.html b/doc/DropboxApi/Results/Base.html new file mode 100644 index 00000000..158627da --- /dev/null +++ b/doc/DropboxApi/Results/Base.html @@ -0,0 +1,152 @@ + + + + + + +class DropboxApi::Results::Base - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::Base +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(result_data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/base.rb, line 3
+def initialize(result_data)
+  @data = result_data
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/BasicAccountBatch.html b/doc/DropboxApi/Results/BasicAccountBatch.html new file mode 100644 index 00000000..63de1de6 --- /dev/null +++ b/doc/DropboxApi/Results/BasicAccountBatch.html @@ -0,0 +1,157 @@ + + + + + + +class DropboxApi::Results::BasicAccountBatch - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::BasicAccountBatch +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(accounts) + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + +
+ + + +
+
# File lib/dropbox_api/results/basic_account_batch.rb, line 3
+def initialize(accounts)
+  super(accounts.map { |a| DropboxApi::Metadata::BasicAccount.new a })
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/CopyBatchResult.html b/doc/DropboxApi/Results/CopyBatchResult.html new file mode 100644 index 00000000..9ca3614e --- /dev/null +++ b/doc/DropboxApi/Results/CopyBatchResult.html @@ -0,0 +1,159 @@ + + + + + + +class DropboxApi::Results::CopyBatchResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::CopyBatchResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(result_data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/copy_batch_result.rb, line 3
+def self.new(result_data)
+  case result_data['.tag']
+  when 'async_job_id'
+    result_data['async_job_id']
+  when 'complete'
+    RelocationBatchResult.new(result_data)
+  else
+    raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/CreateFolderBatchResult.html b/doc/DropboxApi/Results/CreateFolderBatchResult.html new file mode 100644 index 00000000..f57f8d70 --- /dev/null +++ b/doc/DropboxApi/Results/CreateFolderBatchResult.html @@ -0,0 +1,166 @@ + + + + + + +class DropboxApi::Results::CreateFolderBatchResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::CreateFolderBatchResult +

+ +
+ +

Result returned by {Client#create_folder_batch} that may either launch an +asynchronous job or complete synchronously.

+ +

The value will be either a job id or a list of job statuses.

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(result_data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/create_folder_batch_result.rb, line 7
+def self.new(result_data)
+  case result_data['.tag']
+  when 'async_job_id'
+    result_data
+  when 'complete'
+    result_data['entries'].map do |entry|
+      DropboxApi::Results::CreateFolderBatchResultEntry.new(entry)
+    end
+  else
+    raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/CreateFolderBatchResultEntry.html b/doc/DropboxApi/Results/CreateFolderBatchResultEntry.html new file mode 100644 index 00000000..2488dc8d --- /dev/null +++ b/doc/DropboxApi/Results/CreateFolderBatchResultEntry.html @@ -0,0 +1,164 @@ + + + + + + +class DropboxApi::Results::CreateFolderBatchResultEntry - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::CreateFolderBatchResultEntry +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(result_data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/create_folder_batch_result_entry.rb, line 3
+def self.new(result_data)
+  case result_data['.tag']
+  when 'success'
+    DropboxApi::Metadata::Folder.new result_data['metadata']
+  when 'failure'
+    # At the moment, this is a `CreateFolderEntryError` which is an open
+    # union that can only be a `WriteError`. In the future, more errors
+    # could be added to the API which means we'd have to implement the
+    # actual `CreateFolderEntryError` class.
+    DropboxApi::Errors::WriteError
+      .build('Folder operation failed', result_data['failure']['path'])
+  else
+    raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/DeleteBatchResult.html b/doc/DropboxApi/Results/DeleteBatchResult.html new file mode 100644 index 00000000..a1dcb4f9 --- /dev/null +++ b/doc/DropboxApi/Results/DeleteBatchResult.html @@ -0,0 +1,166 @@ + + + + + + +class DropboxApi::Results::DeleteBatchResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::DeleteBatchResult +

+ +
+ +

Result returned by {Client#delete_batch} that may either launch an +asynchronous job or complete synchronously.

+ +

The value will be either a job id or a list of job statuses.

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(result_data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/delete_batch_result.rb, line 7
+def self.new(result_data)
+  case result_data['.tag']
+  when 'async_job_id'
+    result_data
+  when 'complete'
+    result_data['entries'].map do |entry|
+      DropboxApi::Results::DeleteBatchResultEntry.new(entry)
+    end
+  else
+    raise NotImplementedError, "Unknown result type: #{result_data[".tag"]}"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/DeleteBatchResultEntry.html b/doc/DropboxApi/Results/DeleteBatchResultEntry.html new file mode 100644 index 00000000..dea3c12b --- /dev/null +++ b/doc/DropboxApi/Results/DeleteBatchResultEntry.html @@ -0,0 +1,160 @@ + + + + + + +class DropboxApi::Results::DeleteBatchResultEntry - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::DeleteBatchResultEntry +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(result_data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/delete_batch_result_entry.rb, line 3
+def self.new(result_data)
+  case result_data['.tag']
+  when 'success'
+    DropboxApi::Metadata::Resource.new result_data['metadata']
+  when 'failure'
+    DropboxApi::Errors::DeleteError
+      .build('Delete operation failed', result_data['failure'])
+  else
+    raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/GetCopyReferenceResult.html b/doc/DropboxApi/Results/GetCopyReferenceResult.html new file mode 100644 index 00000000..a77a24cb --- /dev/null +++ b/doc/DropboxApi/Results/GetCopyReferenceResult.html @@ -0,0 +1,223 @@ + + + + + + +class DropboxApi::Results::GetCopyReferenceResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::GetCopyReferenceResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ copy_reference() + + click to toggle source + +
+ + +
+ +

A copy reference to the file or folder.

+ + + + +
+
# File lib/dropbox_api/results/get_copy_reference_result.rb, line 9
+def copy_reference
+  @copy_reference ||= @data['copy_reference']
+end
+
+ +
+ + + + +
+ + +
+ +
+ expires() + + click to toggle source + +
+ + +
+ +

The expiration date of the copy reference. This value is currently set to +be far enough in the future so that expiration is effectively not an issue.

+ + + + +
+
# File lib/dropbox_api/results/get_copy_reference_result.rb, line 16
+def expires
+  @expires ||= Time.parse(@data['expires'])
+end
+
+ +
+ + + + +
+ + +
+ +
+ resource() + + click to toggle source + +
+ + +
+ +

Metadata of the file or folder.

+ + + + +
+
# File lib/dropbox_api/results/get_copy_reference_result.rb, line 4
+def resource
+  @resource ||= DropboxApi::Metadata::Resource.new @data['metadata']
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/GetTemporaryLinkResult.html b/doc/DropboxApi/Results/GetTemporaryLinkResult.html new file mode 100644 index 00000000..0e6b2681 --- /dev/null +++ b/doc/DropboxApi/Results/GetTemporaryLinkResult.html @@ -0,0 +1,187 @@ + + + + + + +class DropboxApi::Results::GetTemporaryLinkResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::GetTemporaryLinkResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ file() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/get_temporary_link_result.rb, line 3
+def file
+  @file ||= DropboxApi::Metadata::File.new(@data['metadata'])
+end
+
+ +
+ + + + +
+ + + + + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/GetThumbnailBatchResult.html b/doc/DropboxApi/Results/GetThumbnailBatchResult.html new file mode 100644 index 00000000..c68118ae --- /dev/null +++ b/doc/DropboxApi/Results/GetThumbnailBatchResult.html @@ -0,0 +1,154 @@ + + + + + + +class DropboxApi::Results::GetThumbnailBatchResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::GetThumbnailBatchResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ entries() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/get_thumbnail_batch_result.rb, line 3
+def entries
+  @entries ||= @data['entries'].map do |entry|
+    DropboxApi::Metadata::ThumbnailBatchResultEntry.new entry
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/ListFolderGetLatestCursorResult.html b/doc/DropboxApi/Results/ListFolderGetLatestCursorResult.html new file mode 100644 index 00000000..f45d4ab5 --- /dev/null +++ b/doc/DropboxApi/Results/ListFolderGetLatestCursorResult.html @@ -0,0 +1,152 @@ + + + + + + +class DropboxApi::Results::ListFolderGetLatestCursorResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::ListFolderGetLatestCursorResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ cursor() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb, line 3
+def cursor
+  @data['cursor']
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/ListFolderLongpollResult.html b/doc/DropboxApi/Results/ListFolderLongpollResult.html new file mode 100644 index 00000000..0e08bd25 --- /dev/null +++ b/doc/DropboxApi/Results/ListFolderLongpollResult.html @@ -0,0 +1,189 @@ + + + + + + +class DropboxApi::Results::ListFolderLongpollResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::ListFolderLongpollResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ backoff() + + click to toggle source + +
+ + +
+ +

If present, backoff for at least this many seconds before calling +`list_folder_longpoll` again. This field is optional.

+ + + + +
+
# File lib/dropbox_api/results/list_folder_longpoll_result.rb, line 11
+def backoff
+  @data['backoff']
+end
+
+ +
+ + + + +
+ + +
+ +
+ changes() + + click to toggle source + +
+ + +
+ +

Indicates whether new changes are available. If true, call +`list_folder_continue` to retrieve the changes.

+ + + + +
+
# File lib/dropbox_api/results/list_folder_longpoll_result.rb, line 5
+def changes
+  @data['changes'].to_s == 'true'
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/ListFolderResult.html b/doc/DropboxApi/Results/ListFolderResult.html new file mode 100644 index 00000000..f6480508 --- /dev/null +++ b/doc/DropboxApi/Results/ListFolderResult.html @@ -0,0 +1,226 @@ + + + + + + +class DropboxApi::Results::ListFolderResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::ListFolderResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ cursor() + + click to toggle source + +
+ + +
+ +

Pass the cursor into `list_folder_continue` to see what's changed in +the folder since your previous query.

+ + + + +
+
# File lib/dropbox_api/results/list_folder_result.rb, line 12
+def cursor
+  @data['cursor']
+end
+
+ +
+ + + + +
+ + +
+ +
+ entries() + + click to toggle source + +
+ + +
+ +

A collection of files and directories.

+ + + + +
+
# File lib/dropbox_api/results/list_folder_result.rb, line 4
+def entries
+  @entries ||= @data['entries'].map do |entry|
+    DropboxApi::Metadata::Resource.new entry
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ has_more?() + + click to toggle source + +
+ + +
+ +

If true, then there are more entries available. Pass the cursor to +`list_folder_continue` to retrieve the rest.

+ + + + +
+
# File lib/dropbox_api/results/list_folder_result.rb, line 18
+def has_more?
+  @data['has_more'].to_s == 'true'
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/ListRevisionsResult.html b/doc/DropboxApi/Results/ListRevisionsResult.html new file mode 100644 index 00000000..1b614abc --- /dev/null +++ b/doc/DropboxApi/Results/ListRevisionsResult.html @@ -0,0 +1,189 @@ + + + + + + +class DropboxApi::Results::ListRevisionsResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::ListRevisionsResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ entries() + + click to toggle source + +
+ + +
+ +

A collection of files and directories.

+ + + + +
+
# File lib/dropbox_api/results/list_revisions_result.rb, line 4
+def entries
+  @entries ||= @data['entries'].map do |entry|
+    DropboxApi::Metadata::File.new entry
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+ is_deleted?() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/list_revisions_result.rb, line 10
+def is_deleted?
+  @data['is_deleted'] == true
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/ListSharedLinksResult.html b/doc/DropboxApi/Results/ListSharedLinksResult.html new file mode 100644 index 00000000..6bdb0074 --- /dev/null +++ b/doc/DropboxApi/Results/ListSharedLinksResult.html @@ -0,0 +1,226 @@ + + + + + + +class DropboxApi::Results::ListSharedLinksResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::ListSharedLinksResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ cursor() + + click to toggle source + +
+ + +
+ +

Pass the cursor into `list_folder_continue` to see what's changed in +the folder since your previous query.

+ + + + +
+
# File lib/dropbox_api/results/list_shared_links_result.rb, line 12
+def cursor
+  @data['cursor']
+end
+
+ +
+ + + + +
+ + +
+ +
+ has_more?() + + click to toggle source + +
+ + +
+ +

If true, then there are more entries available. Pass the cursor to +`list_folder_continue` to retrieve the rest.

+ + + + +
+
# File lib/dropbox_api/results/list_shared_links_result.rb, line 18
+def has_more?
+  @data['has_more'].to_s == 'true'
+end
+
+ +
+ + + + +
+ + + + + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/RelocationBatchResult.html b/doc/DropboxApi/Results/RelocationBatchResult.html new file mode 100644 index 00000000..4f4e6073 --- /dev/null +++ b/doc/DropboxApi/Results/RelocationBatchResult.html @@ -0,0 +1,166 @@ + + + + + + +class DropboxApi::Results::RelocationBatchResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::RelocationBatchResult +

+ +
+ +

Result returned by {Client#copy_batch} or {Client#move_batch} that may +either launch an asynchronous job or complete synchronously.

+ +

The value will be either `:in_progress` or a list of job statuses.

+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(result_data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/relocation_batch_result.rb, line 7
+def self.new(result_data)
+  case result_data['.tag']
+  when 'in_progress'
+    :in_progress
+  when 'complete'
+    result_data['entries'].map do |entry|
+      DropboxApi::Results::RelocationBatchResultEntry.new(entry)
+    end
+  else
+    raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/RelocationBatchResultEntry.html b/doc/DropboxApi/Results/RelocationBatchResultEntry.html new file mode 100644 index 00000000..1040a90f --- /dev/null +++ b/doc/DropboxApi/Results/RelocationBatchResultEntry.html @@ -0,0 +1,160 @@ + + + + + + +class DropboxApi::Results::RelocationBatchResultEntry - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::RelocationBatchResultEntry +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(result_data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/relocation_batch_result_entry.rb, line 3
+def self.new(result_data)
+  case result_data['.tag']
+  when 'success'
+    DropboxApi::Metadata::Resource.new result_data['success']
+  when 'failure'
+    DropboxApi::Errors::RelocationBatchEntryError
+      .build('File or folder operation failed', result_data['failure'])
+  else
+    raise NotImplementedError, "Unknown result type: #{result_data['.tag']}"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/SaveCopyReferenceResult.html b/doc/DropboxApi/Results/SaveCopyReferenceResult.html new file mode 100644 index 00000000..42156bf4 --- /dev/null +++ b/doc/DropboxApi/Results/SaveCopyReferenceResult.html @@ -0,0 +1,152 @@ + + + + + + +class DropboxApi::Results::SaveCopyReferenceResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::SaveCopyReferenceResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ resource() + + click to toggle source + +
+ + +
+ +

The saved file or folder in the user's Dropbox.

+ + + + +
+
# File lib/dropbox_api/results/save_copy_reference_result.rb, line 4
+def resource
+  @resource ||= DropboxApi::Metadata::Resource.new @data['metadata']
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/SaveUrlJobStatus.html b/doc/DropboxApi/Results/SaveUrlJobStatus.html new file mode 100644 index 00000000..3ea0538d --- /dev/null +++ b/doc/DropboxApi/Results/SaveUrlJobStatus.html @@ -0,0 +1,162 @@ + + + + + + +class DropboxApi::Results::SaveUrlJobStatus - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::SaveUrlJobStatus +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(result_data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/save_url_job_status.rb, line 3
+def self.new(result_data)
+  case result_data['.tag']
+  when 'in_progress'
+    :in_progress
+  when 'complete'
+    DropboxApi::Metadata::File.new result_data
+  when 'failed'
+    DropboxApi::Errors::SaveUrlError.build('Async job failed',
+                                           result_data['failed'])
+  else
+    raise NotImplementedError, "Unknown result type: #{result_data[".tag"]}"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/SaveUrlResult.html b/doc/DropboxApi/Results/SaveUrlResult.html new file mode 100644 index 00000000..9e691d41 --- /dev/null +++ b/doc/DropboxApi/Results/SaveUrlResult.html @@ -0,0 +1,160 @@ + + + + + + +class DropboxApi::Results::SaveUrlResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::SaveUrlResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ async_job_id() + + click to toggle source + +
+ + +
+ +

Example with an async job:

+ +
{
+  ".tag": "async_job_id",
+  "async_job_id": "VofXAX8DO1sAAAAAAAAD_Q"
+}
+
+ +

I couldn't manage to get anything other than an async job.

+ + + + +
+
# File lib/dropbox_api/results/save_url_result.rb, line 10
+def async_job_id
+  @data['async_job_id']
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/Search.html b/doc/DropboxApi/Results/Search.html new file mode 100644 index 00000000..75ca6248 --- /dev/null +++ b/doc/DropboxApi/Results/Search.html @@ -0,0 +1,94 @@ + + + + + + +module DropboxApi::Results::Search - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module DropboxApi::Results::Search +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxApi/Results/Search/Match.html b/doc/DropboxApi/Results/Search/Match.html new file mode 100644 index 00000000..2054236e --- /dev/null +++ b/doc/DropboxApi/Results/Search/Match.html @@ -0,0 +1,230 @@ + + + + + + +class DropboxApi::Results::Search::Match - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::Search::Match +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/search/match.rb, line 3
+def initialize(data)
+  @data = data
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ match_type() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/search/match.rb, line 7
+def match_type
+  @data['match_type']
+end
+
+ +
+ + + + +
+ + +
+ +
+ resource() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/search/match.rb, line 11
+def resource
+  @resource ||= DropboxApi::Metadata::Resource.new @data['metadata']
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/SearchV2Result.html b/doc/DropboxApi/Results/SearchV2Result.html new file mode 100644 index 00000000..abdb8c1b --- /dev/null +++ b/doc/DropboxApi/Results/SearchV2Result.html @@ -0,0 +1,226 @@ + + + + + + +class DropboxApi::Results::SearchV2Result - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::SearchV2Result +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ cursor() + + click to toggle source + +
+ + +
+ +

Pass the cursor into search_continue to fetch the next page of results. +This field is optional.

+ + + + +
+
# File lib/dropbox_api/results/search_v2_result.rb, line 18
+def cursor
+  @data['cursor']
+end
+
+ +
+ + + + +
+ + +
+ +
+ has_more?() + + click to toggle source + +
+ + +
+ +

Used for paging. If true, indicates there is another page of results +available that can be fetched by calling search again.

+ + + + +
+
# File lib/dropbox_api/results/search_v2_result.rb, line 12
+def has_more?
+  @data['has_more'].to_s == 'true'
+end
+
+ +
+ + + + +
+ + +
+ +
+ matches() + + click to toggle source + +
+ + +
+ +

A list (possibly empty) of matches for the query.

+ + + + +
+
# File lib/dropbox_api/results/search_v2_result.rb, line 4
+def matches
+  @matches ||= @data['matches'].map do |match|
+    DropboxApi::Metadata::SearchMatchV2.new match
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/ShareFolderLaunch.html b/doc/DropboxApi/Results/ShareFolderLaunch.html new file mode 100644 index 00000000..28cfd758 --- /dev/null +++ b/doc/DropboxApi/Results/ShareFolderLaunch.html @@ -0,0 +1,159 @@ + + + + + + +class DropboxApi::Results::ShareFolderLaunch - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::ShareFolderLaunch +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ new(result_data) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/share_folder_launch.rb, line 3
+def self.new(result_data)
+  case result_data['.tag']
+  when 'complete'
+    DropboxApi::Metadata::SharedFolder.new result_data
+  when 'async_job_id'
+    result_data
+  else
+    raise ArgumentError, "Unable to infer resource type for `#{tag}`"
+  end
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/SharedFileMembers.html b/doc/DropboxApi/Results/SharedFileMembers.html new file mode 100644 index 00000000..317e824f --- /dev/null +++ b/doc/DropboxApi/Results/SharedFileMembers.html @@ -0,0 +1,257 @@ + + + + + + +class DropboxApi::Results::SharedFileMembers - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::SharedFileMembers +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ cursor() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/shared_file_members.rb, line 15
+def cursor
+  @data['cursor']
+end
+
+ +
+ + + + +
+ + +
+ +
+ groups() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/shared_file_members.rb, line 7
+def groups
+  @data['groups']
+end
+
+ +
+ + + + +
+ + +
+ +
+ invitees() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/shared_file_members.rb, line 11
+def invitees
+  @data['invitees']
+end
+
+ +
+ + + + +
+ + +
+ +
+ users() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/shared_file_members.rb, line 3
+def users
+  @data['users']
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/SharedFolderMembers.html b/doc/DropboxApi/Results/SharedFolderMembers.html new file mode 100644 index 00000000..6bcbb38a --- /dev/null +++ b/doc/DropboxApi/Results/SharedFolderMembers.html @@ -0,0 +1,257 @@ + + + + + + +class DropboxApi::Results::SharedFolderMembers - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::SharedFolderMembers +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ cursor() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/shared_folder_members.rb, line 15
+def cursor
+  @data['cursor']
+end
+
+ +
+ + + + +
+ + +
+ +
+ groups() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/shared_folder_members.rb, line 7
+def groups
+  @data['groups']
+end
+
+ +
+ + + + +
+ + +
+ +
+ invitees() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/shared_folder_members.rb, line 11
+def invitees
+  @data['invitees']
+end
+
+ +
+ + + + +
+ + +
+ +
+ users() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/shared_folder_members.rb, line 3
+def users
+  @data['users']
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/UploadSessionStart.html b/doc/DropboxApi/Results/UploadSessionStart.html new file mode 100644 index 00000000..e792fde9 --- /dev/null +++ b/doc/DropboxApi/Results/UploadSessionStart.html @@ -0,0 +1,152 @@ + + + + + + +class DropboxApi::Results::UploadSessionStart - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::UploadSessionStart +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ session_id() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File lib/dropbox_api/results/upload_session_start.rb, line 3
+def session_id
+  @data['session_id']
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/DropboxApi/Results/VoidResult.html b/doc/DropboxApi/Results/VoidResult.html new file mode 100644 index 00000000..8ed4f80f --- /dev/null +++ b/doc/DropboxApi/Results/VoidResult.html @@ -0,0 +1,101 @@ + + + + + + +class DropboxApi::Results::VoidResult - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxApi::Results::VoidResult +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/DropboxScaffoldBuilder.html b/doc/DropboxScaffoldBuilder.html new file mode 100644 index 00000000..db6b9e47 --- /dev/null +++ b/doc/DropboxScaffoldBuilder.html @@ -0,0 +1,887 @@ + + + + + + +class DropboxScaffoldBuilder - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class DropboxScaffoldBuilder +

+ +
+ +

This class is useful to set up an existing Dropbox account in a state which +is ready to pass the tests.

+ +

For example, on the tests for the `delete` endpoint you may be deleting the +file at `/delete/file.txt`, so we need to upload a file at that location or +the test won't pass. That's exactly what +{DropboxScaffoldBuilder#delete} is expected to do.

+ +

Other endpoints' tests will have different requirements and this class +is to provide an automated way to fulfill these. For each endpoint we need +to test, you may have a method here that sets up everything that the tests +for that endpoint needs.

+ +

Note that, paradoxically, the methods here use the same methods we want to +test. This shouldn't be a problem as the purpose of this is to allow us +to regenerate the VCR cassettes, so if this automated mechanism fails you +can always do the job manually and record the VCR cassette without using +this.

+ +

The Dropbox server may introduce minor changes over time so it's good +to regenerate the cassettes every now and then, but we don't need to do +it in every execution of the test suite.

+ +
+ + +
+ + + + + +
+
+

Constants

+
+
+ +
PREFIX + +
+ + +
+
+ + + + + +
+
+

Public Class Methods

+
+ + +
+ +
+ fixtures_path() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 40
+def self.fixtures_path
+  File.expand_path('../../fixtures', __FILE__)
+end
+
+ +
+ + + + +
+ + +
+ +
+ new(endpoint_name) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 46
+def initialize(endpoint_name)
+  @endpoint_name = endpoint_name.to_s
+end
+
+ +
+ + + + +
+ + +
+ +
+ prefix_for(endpoint_name) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 36
+def self.prefix_for(endpoint_name)
+  new(endpoint_name).path_prefix
+end
+
+ +
+ + + + +
+ + +
+ +
+ regenerate(endpoint_name) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 30
+def self.regenerate(endpoint_name)
+  builder = new(endpoint_name)
+  builder.clobber
+  builder.generate
+end
+
+ +
+ + + + +
+ + +
+ +
+ regenerate_all() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 23
+def self.regenerate_all
+  public_instance_methods
+    .map(&:to_s)
+    .select { |method_name| method_name.start_with?('build') }
+    .each { |method_name| regenerate(method_name.sub('build_', '')) }
+end
+
+ +
+ + + + +
+ + +
+ +
+
+

Public Instance Methods

+
+ + +
+ +
+ build_copy_batch() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 64
+def build_copy_batch
+  client.upload("#{path_prefix}/regular_file.txt", 'Che primo! aon vas?')
+  client.upload("#{path_prefix}/regular_file_2.txt", 'Pal Calvari, amic')
+end
+
+ +
+ + + + +
+ + +
+ +
+ build_create_file_request() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 69
+def build_create_file_request
+  client.upload("#{path_prefix}/regular_file.txt", 'Arkansas, dude.')
+end
+
+ +
+ + + + +
+ + +
+ +
+ build_delete() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 73
+def build_delete
+  file_contents = 'Tijuana, amigo.'
+
+  client.upload "#{path_prefix}/will_be_deleted.txt", file_contents
+  client.upload "#{path_prefix}/wont_be_deleted.txt", file_contents
+  client.upload "#{path_prefix}/folder/a.txt", file_contents
+  client.upload "#{path_prefix}/folder/b.txt", file_contents
+end
+
+ +
+ + + + +
+ + +
+ +
+ build_get_metadata() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 82
+def build_get_metadata
+  client.upload("#{path_prefix}/file.txt", 'This is a test file.', {
+    client_modified: Time.new(1988, 12, 8, 1, 1, 0, '+00:00')
+  })
+  client.create_folder("#{path_prefix}/folder")
+  client.upload("#{path_prefix}/deleted_file.txt", 'This is a test file.')
+  client.delete("#{path_prefix}/deleted_file.txt")
+end
+
+ +
+ + + + +
+ + + + + +
+ +
+ build_get_thumbnail_batch() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 109
+def build_get_thumbnail_batch
+  file_content = IO.read File.join(self.class.fixtures_path, 'img.png')
+  client.upload("#{path_prefix}/img.png", file_content)
+end
+
+ +
+ + + + +
+ + +
+ +
+ build_list_folder() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 91
+def build_list_folder
+  client.create_folder("#{path_prefix}/shared_folder")
+  client.create_shared_link_with_settings("#{path_prefix}/shared_folder")
+  client.upload("#{path_prefix}/shared_folder/cow.txt", 'Moo.')
+end
+
+ +
+ + + + +
+ + +
+ +
+ build_list_folder_longpoll() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 97
+def build_list_folder_longpoll
+  client.create_folder("#{path_prefix}")
+end
+
+ +
+ + + + +
+ + + + + +
+ +
+ build_upload() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 101
+def build_upload
+  # No need to set up anything
+end
+
+ +
+ + + + +
+ + +
+ +
+ build_upload_by_chunks() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 105
+def build_upload_by_chunks
+  # No op
+end
+
+ +
+ + + + +
+ + +
+ +
+ client() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 60
+def client
+  @client ||= DropboxApi::Client.new
+end
+
+ +
+ + + + +
+ + +
+ +
+ clobber() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 50
+def clobber
+  client.delete path_prefix
+rescue DropboxApi::Errors::NotFoundError
+  false # It's ok if it doesn't exist
+end
+
+ +
+ + + + +
+ + +
+ +
+ generate() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 56
+def generate
+  send "build_#{@endpoint_name}"
+end
+
+ +
+ + + + +
+ + +
+ +
+ path_prefix() + + click to toggle source + +
+ + +
+ +

We have a prefix for each endpoint to avoid conflicts across them

+ + + + +
+
# File spec/support/dropbox_scaffold_builder.rb, line 127
+def path_prefix
+  File.join PREFIX, @endpoint_name
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/Gem.html b/doc/Gem.html new file mode 100644 index 00000000..5022eb17 --- /dev/null +++ b/doc/Gem.html @@ -0,0 +1,94 @@ + + + + + + +module Gem - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module Gem +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/Gemfile.html b/doc/Gemfile.html new file mode 100644 index 00000000..1042d4e7 --- /dev/null +++ b/doc/Gemfile.html @@ -0,0 +1,736 @@ + + + + + + +Gemfile - RDoc Documentation + + + + + + + + + + + + + + +
+ +

source 'rubygems.org'

+ +

gemspec

+ +

group :development do

+ +
gem 'bundler', '>= 1.7'
+gem 'rake'
+
+# Test
+gem 'rspec'
+gem 'vcr'
+gem 'webmock'
+
+# Gem dependencies
+if RUBY_VERSION >= '2.6'
+  gem 'faraday', '~> 2.0'
+  gem 'faraday-net_http_persistent'
+else
+  gem 'faraday', '~> 1.0'
+end
+
+# Documentation
+gem 'redcarpet'
+gem 'yard-tests-rspec', git: 'https://github.com/Jesus/yard-spec-plugin.git'
+
+# Debugging
+gem 'byebug'
+
+# Code linting
+gem 'rubocop', require: false
+gem 'rubocop-rspec', require: false
+
+ +

end

+
+ + + + + diff --git a/doc/Gemfile_lock.html b/doc/Gemfile_lock.html new file mode 100644 index 00000000..c002d614 --- /dev/null +++ b/doc/Gemfile_lock.html @@ -0,0 +1,832 @@ + + + + + + +Gemfile.lock - RDoc Documentation + + + + + + + + + + + + + + +
+ +

GIT

+ +
remote: https://github.com/Jesus/yard-spec-plugin.git
+revision: ab90d3e59f2064b3f9862479f4de978b61630dbd
+specs:
+  yard-tests-rspec (0.1.1)
+    yard
+ +

PATH

+ +
remote: .
+specs:
+  dropbox_api (0.1.21)
+    faraday (< 3.0)
+    oauth2 (~> 1.1)
+ +

GEM

+ +
remote: https://rubygems.org/
+specs:
+  addressable (2.7.0)
+    public_suffix (>= 2.0.2, < 5.0)
+  ast (2.4.2)
+  byebug (11.1.3)
+  crack (0.4.5)
+    rexml
+  diff-lcs (1.4.4)
+  faraday (1.10.0)
+    faraday-em_http (~> 1.0)
+    faraday-em_synchrony (~> 1.0)
+    faraday-excon (~> 1.1)
+    faraday-httpclient (~> 1.0)
+    faraday-multipart (~> 1.0)
+    faraday-net_http (~> 1.0)
+    faraday-net_http_persistent (~> 1.0)
+    faraday-patron (~> 1.0)
+    faraday-rack (~> 1.0)
+    faraday-retry (~> 1.0)
+    ruby2_keywords (>= 0.0.4)
+  faraday-em_http (1.0.0)
+  faraday-em_synchrony (1.0.0)
+  faraday-excon (1.1.0)
+  faraday-httpclient (1.0.1)
+  faraday-multipart (1.0.3)
+    multipart-post (>= 1.2, < 3)
+  faraday-net_http (1.0.1)
+  faraday-net_http_persistent (1.2.0)
+  faraday-patron (1.0.0)
+  faraday-rack (1.0.0)
+  faraday-retry (1.0.3)
+  hashdiff (1.0.1)
+  jwt (2.3.0)
+  multi_json (1.15.0)
+  multi_xml (0.6.0)
+  multipart-post (2.1.1)
+  oauth2 (1.4.9)
+    faraday (>= 0.17.3, < 3.0)
+    jwt (>= 1.0, < 3.0)
+    multi_json (~> 1.3)
+    multi_xml (~> 0.5)
+    rack (>= 1.2, < 3)
+  parallel (1.20.1)
+  parser (3.0.0.0)
+    ast (~> 2.4.1)
+  public_suffix (4.0.6)
+  rack (2.2.3)
+  rainbow (3.0.0)
+  rake (13.0.3)
+  redcarpet (3.5.1)
+  regexp_parser (2.0.3)
+  rexml (3.2.4)
+  rspec (3.10.0)
+    rspec-core (~> 3.10.0)
+    rspec-expectations (~> 3.10.0)
+    rspec-mocks (~> 3.10.0)
+  rspec-core (3.10.1)
+    rspec-support (~> 3.10.0)
+  rspec-expectations (3.10.1)
+    diff-lcs (>= 1.2.0, < 2.0)
+    rspec-support (~> 3.10.0)
+  rspec-mocks (3.10.2)
+    diff-lcs (>= 1.2.0, < 2.0)
+    rspec-support (~> 3.10.0)
+  rspec-support (3.10.2)
+  rubocop (1.9.1)
+    parallel (~> 1.10)
+    parser (>= 3.0.0.0)
+    rainbow (>= 2.2.2, < 4.0)
+    regexp_parser (>= 1.8, < 3.0)
+    rexml
+    rubocop-ast (>= 1.2.0, < 2.0)
+    ruby-progressbar (~> 1.7)
+    unicode-display_width (>= 1.4.0, < 3.0)
+  rubocop-ast (1.4.1)
+    parser (>= 2.7.1.5)
+  rubocop-rspec (2.2.0)
+    rubocop (~> 1.0)
+    rubocop-ast (>= 1.1.0)
+  ruby-progressbar (1.11.0)
+  ruby2_keywords (0.0.5)
+  unicode-display_width (2.0.0)
+  vcr (6.0.0)
+  webmock (3.11.2)
+    addressable (>= 2.3.6)
+    crack (>= 0.3.2)
+    hashdiff (>= 0.4.0, < 2.0.0)
+  yard (0.9.26)
+ +

PLATFORMS

+ +
ruby
+
+ +

DEPENDENCIES

+ +
bundler (>= 1.7)
+byebug
+dropbox_api!
+faraday (~> 1.0)
+rake
+redcarpet
+rspec
+rubocop
+rubocop-rspec
+vcr
+webmock
+yard-tests-rspec!
+ +

BUNDLED WITH

+ +
1.17.3
+
+ + + + + diff --git a/doc/LICENSE.html b/doc/LICENSE.html new file mode 100644 index 00000000..2e85ed71 --- /dev/null +++ b/doc/LICENSE.html @@ -0,0 +1,722 @@ + + + + + + +LICENSE - RDoc Documentation + + + + + + + + + + + + + + +
+ +

The MIT License (MIT)

+ +

Copyright © 2016 Jesús Burgos Maciá

+ +

Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the “Software”), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions:

+ +

The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software.

+ +

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE.

+
+ + + + + diff --git a/doc/Object.html b/doc/Object.html new file mode 100644 index 00000000..5faead91 --- /dev/null +++ b/doc/Object.html @@ -0,0 +1,203 @@ + + + + + + +class Object - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class Object +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ build_file_hash(attrs = {}) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File spec/metadata/file_spec.rb, line 2
+def build_file_hash(attrs = {})
+  {
+    '.tag' => 'file',
+    'name' => 'visrez-video.mp4',
+    'path_lower' => '/visrez-video.mp4',
+    'path_display' => '/visrez-video.mp4',
+    'id' => 'id:ARSNw7QJjrAAAAAAAAAAAQ',
+    'client_modified' => '2016-05-22T09:31:26Z',
+    'server_modified' => '2016-05-22T09:31:26Z',
+    'rev' => '2c824061bdd',
+    'size' => 1136802
+  }.merge(attrs)
+end
+
+ +
+ + + + +
+ + +
+ +
+ init() + + click to toggle source + +
+ + +
+ + + + +
+ Calls superclass method + +
+ + + +
+
# File yardoc/templates/default/method_details/setup.rb, line 1
+def init
+  super
+  sections.last.place(:specs).before(:source)
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/README_md.html b/doc/README_md.html new file mode 100644 index 00000000..3b903e38 --- /dev/null +++ b/doc/README_md.html @@ -0,0 +1,1012 @@ + + + + + + +README - RDoc Documentation + + + + + + + + + + + + + + +
+ +

DropboxApi

+ +

Library for communicating with Dropbox API v2.

+ +

Installation

+ +

Add this line to your application's Gemfile:

+ +
gem 'dropbox_api'
+
+ +

And then execute:

+ +
$ bundle
+ +

Or install it yourself as:

+ +
$ gem install dropbox_api
+ +

Documentation

+ +

Please, refer to this gem's custom Dropbox API documentation. +Most of the time you'll be checking the available +endpoints.

+ +

Unfortunately, the documentation at RubyDoc.info is disrecommended because +it lacks some nice features that have been added with YARD plugins:

+
  • +

    Each endpoint includes its tests right below the description, this works as +an example of its usage.

    +
  • +

    All endpoints are shown as methods of the Client class, just +as you will use them.

    +
+ +

Basic set up

+ +

Authorize your application

+ +

Dropbox uses OAuth, in order to use this library from your application +you'll have to get an authorization code.

+ +

Once you have it, just pass it on client initialization:

+ +
DropboxApi::Client.new("VofXAX8D...")
+#=> #<DropboxApi::Client ...>
+
+ +

Or set it as an ENV variable called DROPBOX_OAUTH_BEARER, for +example:

+ +
ENV["DROPBOX_OAUTH_BEARER"] = "VofXAX8D..."
+DropboxApi::Client.new
+#=> #<DropboxApi::Client ...>
+
+ +

The official documentation on the process to get an authorization code is +here, +it describes the two options listed below.

+ +

Option A: Get your access token from the website

+ +

For a quick test, you can obtain an access token from the App Console in Dropbox’s website. Select +from My apps your application, you may need to create one if you +haven't done so yet. Under your application settings, find section +OAuth 2, there is a button to generate an access token.

+ +

Option B: OAuth2 Code Flow

+ +

This is typically what you will use in production, you can obtain an +authorization code with a 3-step process:

+ +
# 1. Get an authorization URL.
+authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET)
+authenticator.auth_code.authorize_url #=> "https://www.dropbox.com/..."
+
+# 2. Log into Dropbox and authorize your app. You need to open the
+# authorization URL in your browser.
+
+# 3. Exchange the authorization code for a reusable access token (not visible
+#    to the user).
+access_token = authenticator.auth_code.get_token(CODE) #=> #<OAuth2::AccessToken ...>`
+access_token.token #=> "VofXAX8D..."
+
+# Keep this token, you'll need it to initialize a `DropboxApi::Client` object:
+client = DropboxApi::Client.new(access_token: access_token)
+
+# For backwards compatibility, the following also works:
+client = DropboxApi::Client.new(access_token.token)
+
+ +
Integration with Rails
+ +

If you have a Rails application, you might be interested in this setup +guide.

+ +
Using refresh tokens
+ +

Access tokens are short-lived by default (as of September 30th, 2021), +applications that require long-lived access to the API without additional +interaction with the user should use refresh tokens.

+ +

The process is similar but a token refresh might seamlessly occur as you +perform API calls. When this happens you'll need to store the new token +hash if you want to continue using this session, you can use the +on_token_refreshed callback to do this.

+ +
# 1. Get an authorization URL, requesting offline access type.
+authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET)
+authenticator.auth_code.authorize_url(token_access_type: 'offline')
+
+# 2. Log into Dropbox and authorize your app. You need to open the
+#    authorization URL in your browser.
+
+# 3. Exchange the authorization code for a reusable access token
+access_token = authenticator.auth_code.get_token(CODE) #=> #<OAuth2::AccessToken ...>`
+
+# You can now use the access token to initialize a DropboxApi::Client, you
+# should also provide a callback function to store the updated access token
+# whenever it's refreshed.
+client = DropboxApi::Client.new(
+  access_token: access_token,
+  on_token_refreshed: lambda { |new_token_hash|
+    # token_hash is a serializable Hash, something like this:
+    # {
+    #   "uid"=>"440",
+    #   "token_type"=>"bearer",
+    #   "scope"=>"account_info.read account_info.write...",
+    #   "account_id"=>"dbid:AABOLtA1rT6rRK4vajKZ...",
+    #   :access_token=>"sl.A5Ez_CBsqJILhDawHlmXSoZEhLZ4nuLFVRs6AJ...",
+    #   :refresh_token=>"iMg4Me_oKYUAAAAAAAAAAapQixCgwfXOxuubCuK_...",
+    #   :expires_at=>1632948328
+    # }
+    SomewhereSafe.save(new_token_hash)
+  }
+)
+
+ +

Once you've gone through the process above, you can skip the steps that +require user interaction in subsequent initializations of +DropboxApi::Client. For example:

+ +
# 1. Initialize an authenticator
+authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET)
+
+# 2. Retrieve the token hash you previously stored somewhere safe, you can use
+#    it to build a new access token.
+access_token = OAuth2::AccessToken.from_hash(authenticator, token_hash)
+
+# 3. You now have an access token, so you can initialize a client like you
+#    would normally:
+client = DropboxApi::Client.new(
+  access_token: access_token,
+  on_token_refreshed: lambda { |new_token_hash|
+    SomewhereSafe.save(new_token_hash)
+  }
+)
+
+ +

Performing API calls

+ +

Once you've initialized a client, for example:

+ +
client = DropboxApi::Client.new("VofXAX8D...")
+#=> #<DropboxApi::Client ...>
+
+ +

You can perform an API call like this:

+ +
result = client.list_folder "/sample_folder"
+#=> #<DropboxApi::Results::ListFolderResult>
+result.entries
+#=> [#<DropboxApi::Metadata::Folder>, #<DropboxApi::Metadata::File>]
+result.has_more?
+#=> false
+
+ +

The instance of Client we've initialized is the one +you'll be using to perform API calls. You can check the class' +documentation to find all +available endpoints.

+ +

Large file uploads

+ +

If you need to upload files larger than 150MB the default +#upload endpoint won't work. Instead, you need to start a +upload session and upload the file in small chunks.

+ +

To make this easier, the method upload_by_chunks will handle +this for you, example:

+ +
client = DropboxApi::Client.new("VofXAX8D...")
+#=> #<DropboxApi::Client ...>
+File.open("large_file.avi") do |f|
+  client.upload_by_chunks "/remote_path.txt", f
+end
+
+ +

Check out the method +documentation to find out all available options.

+ +

Accessing Team Folders

+ +

In order to access your team scope you need to add the namespace_id to you +request headers. This can be done using the middlewere layer as per the +below:

+ +
client = DropboxApi::Client.new("VofXAX8D...")
+#=> #<DropboxApi::Client ...>
+client.namespace_id = client.get_current_account.root_info.root_namespace_id
+
+client.list_folder('')
+#=> Now returns the team folders
+
+ +

You could unset the namespace ID at any point afterwards with just:

+ +
client.namespace_id = nil
+
+ +

Dependencies

+ +

This gem depends on oauth2 +and faraday.

+ +

It has official support for Ruby versions 2.x.

+ +

Development

+ +

After checking out the repo, run bin/setup to install +dependencies. Then, run bin/console for an interactive prompt +that will allow you to experiment.

+ +

Testing

+ +

I recommend you to use a test account other than your main one.

+ +

We use VCR to record the HTTP calls to Dropbox, however we sometimes need +to regenerate the cassettes. Let's take list_folder as an +example to show what would be the procedure to do so:

+
  1. +

    Manually delete the existing cassettes in +spec/fixtures/vcr_cassettes/list_folder/*.yml.

    +
  2. +

    Run the task to build the scaffolding in your Dropbox account so the tests +will pass. If it doesn't exist you may need to write it yourself, check +the DropboxScaffoldBuilder class to find all existing scaffold +builders.

    + +
    DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rake test:build_scaffold[list_folder]
    +
    + +

    Note that you'll have to type rake +test:build_scaffold\[list_folder\] if you use zsh.

    + +

    You can build all available scaffolds with just rake +test:build_scaffold.

    +
  3. +

    Run the tests and the cassettes will be written:

    + +
    DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rspec spec/endpoints/files/list_folder_spec.rb
    +
    +
+ +

The OAuth bearer shouldn't have been recorded in the cassette and it +should've been filtered. However, you may want to double check before +pushing your updates to Github.

+ +

Tip: you can simply run export +DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER at the beginning of your work +session so you don't need to prefix it in every command line.

+ +

Contributing

+ +

Any help will be much appreciated. The easiest way to help is to implement +one or more of the endpoints +that are still pending. To see how the endpoints are implemented, check +out the lib/dropbox_api/endpoints folder.

+
+ + + + + diff --git a/doc/RELEASING_md.html b/doc/RELEASING_md.html new file mode 100644 index 00000000..967427b5 --- /dev/null +++ b/doc/RELEASING_md.html @@ -0,0 +1,711 @@ + + + + + + +RELEASING - RDoc Documentation + + + + + + + + + + + + + + +
+
  1. +

    Bump version in lib/dropbox_api/version.rb.

    +
  2. +

    Tag a new release in Github, summarize the changes since the last release.

    +
  3. +

    Build gem: gem build dropbox_api.gemspec.

    +
  4. +

    Publish gem: gem push dropbox_api-[...].gem.

    +
  5. +

    Update documentation.

    +
+
+ + + + + diff --git a/doc/RSpecDescribeHandler.html b/doc/RSpecDescribeHandler.html new file mode 100644 index 00000000..51d6d7f2 --- /dev/null +++ b/doc/RSpecDescribeHandler.html @@ -0,0 +1,160 @@ + + + + + + +class RSpecDescribeHandler - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class RSpecDescribeHandler +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ process() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File yardoc/rspec.rb, line 6
+def process
+  objname = statement.parameters.first.jump(:string_content).source
+  if statement.parameters[1]
+    src = statement.parameters[1].jump(:string_content).source
+    objname += (src[0] == '#' ? '' : '::') + src
+  end
+  obj = {spec: owner ? (owner[:spec] || '') : ''}
+  obj[:spec] += objname
+  parse_block(statement.last.last, owner: obj)
+rescue YARD::Handlers::NamespaceMissingError
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/RSpecItHandler.html b/doc/RSpecItHandler.html new file mode 100644 index 00000000..02c606de --- /dev/null +++ b/doc/RSpecItHandler.html @@ -0,0 +1,162 @@ + + + + + + +class RSpecItHandler - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class RSpecItHandler +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ process() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File yardoc/rspec.rb, line 22
+def process
+  return if owner.nil?
+  obj = P(owner[:spec])
+  return if obj.is_a?(Proxy)
+
+  obj[:specifications] ||= []
+  obj[:specifications] << {
+    name: statement.parameters.first.jump(:string_content).source,
+    file: statement.file,
+    line: statement.line,
+    source: statement.last.last.source
+  }
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/Rakefile.html b/doc/Rakefile.html new file mode 100644 index 00000000..eb125e47 --- /dev/null +++ b/doc/Rakefile.html @@ -0,0 +1,707 @@ + + + + + + +Rakefile - RDoc Documentation + + + + + + + + + + + + + + +
+ +

require 'bundler/gem_tasks' require 'rspec/core/rake_task' +require File.expand_path('../spec/support/rake_tasks', __FILE__)

+ +

RSpec::Core::RakeTask.new(:spec)

+ +

task default: :spec

+
+ + + + + diff --git a/doc/TODO_md.html b/doc/TODO_md.html new file mode 100644 index 00000000..8e57b117 --- /dev/null +++ b/doc/TODO_md.html @@ -0,0 +1,754 @@ + + + + + + +TODO - RDoc Documentation + + + + + + + + + + + + + + +
+ +

Pre-release for v0.1.21

+
  • +

    Support Faraday 2.0

    +
  • +

    Chunked downloads?

    +
  • +

    Add instructions to support a new endpoint and send a PR.

    +
  • +

    Release!

    +
+ +

Immediate

+
  • +

    Test all added classes since last release.

    +
  • +

    Add scaffoldings for the new endpoints.

    +
  • +

    Test all new paths to build errors & results.

    +
  • +

    Update coverage document.

    +
  • +

    Clear out Rubocop's TODO.

    +
  • +

    Release!

    +
  • +

    Update the guide to contribute, show how an endpoint is implemented and +documented.

    +
+ +

Mid-term

+
  • +

    Remove dependency on Faraday.

    +
  • +

    Complete full API coverage.

    +
+ +

Dreaming

+
  • +

    Support streams.

    +
  • +

    Add a layer to handle pagination.

    +
+
+ + + + + diff --git a/doc/YARD.html b/doc/YARD.html new file mode 100644 index 00000000..bc52d0b1 --- /dev/null +++ b/doc/YARD.html @@ -0,0 +1,94 @@ + + + + + + +module YARD - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module YARD +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/YARD/EndpointHandler.html b/doc/YARD/EndpointHandler.html new file mode 100644 index 00000000..34333331 --- /dev/null +++ b/doc/YARD/EndpointHandler.html @@ -0,0 +1,228 @@ + + + + + + +class YARD::EndpointHandler - RDoc Documentation + + + + + + + + + + + + + + +
+

+ class YARD::EndpointHandler +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ name() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File yardoc/endpoint_handler.rb, line 18
+def name
+  statement.parameters.first.jump(:tstring_content, :ident).source
+end
+
+ +
+ + + + +
+ + +
+ +
+ parameters() + + click to toggle source + +
+ + +
+ + + + + + +
+
# File yardoc/endpoint_handler.rb, line 22
+def parameters
+  # This method is taken from YARD, ideally we would just use it but I
+  # couldn't find a way to invoke it from here, so I had to copy it over.
+  # It would be nice to get rid of this method and use YARD's
+  # implementation instead.
+  #
+  # Reference to original code:
+  #   YARD gem (0.9.5): lib/yard/handlers/ruby/method_handler.rb
+  #   Github: https://git.io/vMLQp
+  args = statement.jump(:block_var).jump(:params)
+  return [] unless args.is_a? YARD::Parser::Ruby::ParameterNode
+
+  params = []
+
+  if args.unnamed_required_params
+    params += args.unnamed_required_params.map {|a| [a.source, nil] }
+  end
+
+  if args.unnamed_optional_params
+    params += args.unnamed_optional_params.map do |a|
+      [a[0].source, a[1].source]
+    end
+  end
+
+  params << ['*' + args.splat_param.source, nil] if args.splat_param
+
+  if args.unnamed_end_params
+    params += args.unnamed_end_params.map {|a| [a.source, nil] }
+  end
+
+  if args.named_params
+    params += args.named_params.map do |a|
+      [a[0].source, a[1] ? a[1].source : nil]
+    end
+  end
+
+  if args.double_splat_param
+    params << ['**' + args.double_splat_param.source, nil]
+  end
+
+  params << ['&' + args.block_param.source, nil] if args.block_param
+
+  params
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/YARD/EndpointHandler/CodeObjects.html b/doc/YARD/EndpointHandler/CodeObjects.html new file mode 100644 index 00000000..f615e3bf --- /dev/null +++ b/doc/YARD/EndpointHandler/CodeObjects.html @@ -0,0 +1,94 @@ + + + + + + +module YARD::EndpointHandler::CodeObjects - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module YARD::EndpointHandler::CodeObjects +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/YARD/Templates.html b/doc/YARD/Templates.html new file mode 100644 index 00000000..b7d083da --- /dev/null +++ b/doc/YARD/Templates.html @@ -0,0 +1,94 @@ + + + + + + +module YARD::Templates - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module YARD::Templates +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/YARD/Templates/Helpers.html b/doc/YARD/Templates/Helpers.html new file mode 100644 index 00000000..516aa916 --- /dev/null +++ b/doc/YARD/Templates/Helpers.html @@ -0,0 +1,94 @@ + + + + + + +module YARD::Templates::Helpers - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module YARD::Templates::Helpers +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+ + + + diff --git a/doc/YARD/Templates/Helpers/HtmlHelper.html b/doc/YARD/Templates/Helpers/HtmlHelper.html new file mode 100644 index 00000000..6d01ef03 --- /dev/null +++ b/doc/YARD/Templates/Helpers/HtmlHelper.html @@ -0,0 +1,189 @@ + + + + + + +module YARD::Templates::Helpers::HtmlHelper - RDoc Documentation + + + + + + + + + + + + + + +
+

+ module YARD::Templates::Helpers::HtmlHelper +

+ +
+ +
+ + +
+ + + + + + + + + +
+
+

Public Instance Methods

+
+ + +
+ +
+ unindent(str) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File yardoc/helpers/html_helper.rb, line 4
+def unindent(str)
+  indent_size = str.split("\n").map do |line|
+    line = untab(line)
+    white_span = line[/\A(\s+)/]
+
+    white_span.nil? ? nil : white_span.size
+  end.compact.min
+
+  str.gsub(/^( ){#{indent_size}}/, '')
+end
+
+ +
+ + + + +
+ + +
+ +
+ untab(str, tab_size = 2) + + click to toggle source + +
+ + +
+ + + + + + +
+
# File yardoc/helpers/html_helper.rb, line 15
+def untab(str, tab_size = 2)
+  tab_space = 2
+
+  str.gsub("\t", ' ' * tab_space)
+end
+
+ +
+ + + + +
+ + +
+ +
+
+ + + + diff --git a/doc/api_coverage_md.html b/doc/api_coverage_md.html new file mode 100644 index 00000000..2117320d --- /dev/null +++ b/doc/api_coverage_md.html @@ -0,0 +1,826 @@ + + + + + + +api_coverage - RDoc Documentation + + + + + + + + + + + + + + +
+ +

@title API Implementation Coverage

+ +

The Dropbox API changes frequently, so you may find out that the feature +that you need is missing. This document indicates what endpoints have been +implemented.

+ +

Full moon means fully implemented. Half moon means that the basic +functionality of the endpoint has been implemented but some options may be +missing. Guess what new moon means.

+ +

File properties

+ +

API call | Status — | :—: /properties/add | 🌑 +/properties/overwrite | 🌑 /properties/remove | 🌑 +/properties/search | 🌑 +/properties/search/continue | 🌑 +/properties/update | 🌑 /templates/add_for_user | +🌑 /templates/get_for_user | 🌑 +/templates/list_for_user | 🌑 +/templates/remove_for_user | 🌑 +/templates/update_for_user | 🌑

+ +

File requests

+ +

API call | Status — | :—: /create | 🌕 /get | 🌑 +/list | 🌑 /update | 🌑

+ +

Files

+ +

API call | Status — | :—: /copy | 🌕 /copy_batch | +🌕 /copy_batch/check | 🌕 /copy_reference/get | 🌕 +/copy_reference/save | 🌕 /create_folder | 🌕 +/create_folder_batch | 🌕 +/create_folder_batch/check | 🌕 /delete | 🌕 +/delete_batch | 🌕 /delete_batch/check | 🌕 +/download | 🌔 /download_zip | 🌑 +/get_metadata | 🌕 /get_preview | 🌕 +/get_temporary_link | 🌕 +/get_temporary_upload_link | 🌑 /get_thumbnail | 🌕 +/get_thumbnail_batch | 🌑 /list_folder | 🌕 +/list_folder/continue | 🌕 +/list_folder/get_latest_cursor | 🌕 +/list_folder/longpoll | 🌕 /list_revisions | 🌕 +/move | 🌕 /move_batch | 🌑 +/move_batch/check | 🌑 /permanently_delete | 🌕 +/restore | 🌕 /save_url | 🌕 +/save_url/check_job_status | 🌕 /search_v2 | 🌔 +/upload | 🌕 /upload_session/append | alias? +/upload_session/append_v2 | 🌕 +/upload_session/finish | 🌕 +/upload_session/finish_batch | 🌑 +/upload_session/finish_batch/check | 🌑 +/upload_session/start | 🌕

+ +

Paper

+ +

API call | Status — | :—: /docs/archive | 🌑 +/docs/create | 🌑 /docs/download | 🌑 +/docs/folder_users/list | 🌑 +/docs/folder_users/list/continue | 🌑 +/docs/get_folder_info | 🌑 /docs/list | 🌑 +/docs/list/continue | 🌑 /docs/permanently_delete +| 🌑 /docs/sharing_policy/get | 🌑 +/docs/sharing_policy/set | 🌑 /docs/update | 🌑 +/docs/users/add | 🌑 /docs/users/list | 🌑 +/docs/users/list/continue | 🌑 /docs/users/remove +| 🌑

+ +

Sharing

+ +

API call | Status — | :—: /add_file_member | 🌕 +/add_folder_member | 🌕 /check_job_status | 🌑 +/check_remove_member_job_status | 🌑 +/check_share_job_status | 🌑 +/create_shared_link_with_settings | 🌓 +/get_file_metadata | 🌑 /get_file_metadata/batch | +🌑 /get_folder_metadata | 🌑 /get_shared_link_file +| 🌑 /get_shared_link_metadata | 🌔 +/list_file_members | 🌕 /list_file_members/batch | +🌑 /list_file_members/continue | 🌑 +/list_folder_members | 🌕 +/list_folder_members/continue | 🌑 /list_folders | +🌑 /list_folders/continue | 🌑 +/list_mountable_folders | 🌑 +/list_mountable_folders/continue | 🌑 +/list_received_files | 🌑 +/list_received_files/continue | 🌑 +/list_shared_links | 🌕 +/modify_shared_link_settings | 🌑 /mount_folder | +🌑 /relinquish_file_membership | 🌑 +/relinquish_folder_membership | 🌑 +/remove_file_member_2 | 🌑 /remove_folder_member | +🌑 /revoke_shared_link | 🌕 /set_access_inheritance +| 🌑 /share_folder | 🌕 /transfer_folder | 🌑 +/unmount_folder | 🌑 /unshare_file | 🌕 +/unshare_folder | 🌑 /update_file_member | 🌑 +/update_folder_member | 🌑 /update_folder_policy | +🌑

+ +

Users

+ +

API call | Status — | :—: /get_account | 🌕 +/get_account_batch | 🌕 /get_current_account | 🌕 +/get_space_usage | 🌕

+ +

Dropbox Business API

+ +

Unfortunately, none of the Dropbox Business endpoints have been +implemented. If this is a problem for you, please open an issue.

+
+ + + + + diff --git a/doc/bin/setup.html b/doc/bin/setup.html new file mode 100644 index 00000000..5f0de1fa --- /dev/null +++ b/doc/bin/setup.html @@ -0,0 +1,706 @@ + + + + + + +setup - RDoc Documentation + + + + + + + + + + + + + + +
+ +

#!/bin/bash set -euo pipefail IFS=$'nt'

+ +

bundle install

+ +

# Do any other automated setup that you need to do here

+
+ + + + + diff --git a/doc/created.rid b/doc/created.rid new file mode 100644 index 00000000..239dba3f --- /dev/null +++ b/doc/created.rid @@ -0,0 +1,747 @@ +Sat, 05 Mar 2022 10:28:21 +0100 +./RELEASING.md Sat, 07 Dec 2019 19:49:22 +0100 +./dropbox_api-0.1.21.gem Sat, 05 Mar 2022 10:25:06 +0100 +./api_coverage.md Sun, 07 Feb 2021 18:02:08 +0100 +./LICENSE Sat, 07 Dec 2019 19:49:22 +0100 +./bin/setup Sat, 07 Dec 2019 19:49:22 +0100 +./bin/console Sun, 07 Feb 2021 18:02:08 +0100 +./spec/spec_helper.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/client_spec.rb Sat, 05 Mar 2022 10:13:57 +0100 +./spec/endpoints/sharing/revoke_shared_link_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/sharing/get_shared_link_metadata_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/sharing/list_shared_links_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/sharing/list_file_members_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/sharing/unshare_file_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/sharing/list_folder_members_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/sharing/add_folder_member_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/sharing/share_folder_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/sharing/add_file_member_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/sharing/create_shared_link_with_settings_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/auth/token_revoke_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/content_upload_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/file_requests/create_file_request_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/users/get_account_batch_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/users/get_current_account_spec.rb Sat, 18 Sep 2021 16:32:45 +0200 +./spec/endpoints/users/get_space_usage_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/users/get_account_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/virtual/upload_by_chunks_spec.rb Wed, 29 Sep 2021 20:07:19 +0200 +./spec/endpoints/files/upload_session_finish_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/delete_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/copy_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/list_revisions_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/copy_reference_save_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/create_folder_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/search_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/get_temporary_link_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/copy_batch_check_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/copy_reference_get_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/restore_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/upload_session_start_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/get_thumbnail_batch_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/create_folder_batch_check_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/save_url_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/get_thumbnail_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/list_folder_spec.rb Sat, 18 Sep 2021 16:32:45 +0200 +./spec/endpoints/files/move_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/create_folder_batch_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/permanently_delete_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/save_url_check_job_status_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/upload_session_append_v2_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/delete_batch_check_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/list_folder_continue_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/upload_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/delete_batch_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/get_preview_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/copy_batch_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/get_metadata_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/list_folder_get_latest_cursor_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/endpoints/files/search_continue_spec.rb Sat, 18 Sep 2021 16:56:13 +0200 +./spec/endpoints/files/list_folder_longpoll_spec.rb Sun, 27 Feb 2022 14:43:42 +0100 +./spec/endpoints/files/download_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/authenticator_spec.rb Wed, 29 Sep 2021 23:30:17 +0200 +./spec/chunked_uploader_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/support/vcr.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/support/rake_tasks.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/support/dropbox_scaffold_builder.rb Sun, 27 Feb 2022 14:39:15 +0100 +./spec/fixtures/file.txt Sat, 07 Dec 2019 19:49:22 +0100 +./spec/fixtures/img.png Sat, 07 Dec 2019 19:49:22 +0100 +./spec/fixtures/vcr_cassettes/save_url_check_job_status/in_progress.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/save_url_check_job_status/complete.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/save_url_check_job_status/failed.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/move/success_rename.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/move/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/move/success_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/move/success_file.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/save_url/invalid_url.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/save_url/success_dropbox.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/save_url/success_external.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_account_batch/no_account.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_account_batch/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_temporary_link/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_temporary_link/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_thumbnail_batch/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_thumbnail_batch/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/delete/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/delete/success_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/delete/invalid_parent_rev.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/delete/success_file.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/delete_batch_check/invalid_async_job_id.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/delete_batch_check/mixed_entries.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_preview/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_preview/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_batch/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_batch/autorename_success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_account/no_account.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_account/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/revoke_shared_link/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/revoke_shared_link/malformed_shared_link.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/revoke_shared_link/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/revoke_shared_link/access_denied.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_reference_get/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_reference_get/success_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_reference_get/success_file.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/share_folder/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/share_folder/bad_path.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_current_account/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload_session_finish/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder_continue/list_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder_continue/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_revisions/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_revisions/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload_by_chunks/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload_by_chunks/success_add.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload_by_chunks/success_io.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder/invalid_namespace_id.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder/success_shared_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder/success_with_namespace_id.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder/unset_namespace_id.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/add_file_member/success_comment.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/add_file_member/success_2.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/add_file_member/success_1.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/add_file_member/error_no_permission.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/search/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/search/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/client_with_namespace_id.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_shared_link_metadata/error_not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_shared_link_metadata/success_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_shared_link_metadata/success_file.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_folder_batch_check/invalid_async_job_id.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_folder_batch_check/mixed_entries.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder_get_latest_cursor/list_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder_get_latest_cursor/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/search_continue/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/search_continue/search.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_file_request/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_file_request/not_a_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_reference_save/conflict.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_reference_save/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_reference_save/malformed_path.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_reference_save/invalid_reference.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_reference_save/no_permission.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_reference_save/success_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_reference_save/success_file.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload_session_start/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/download/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/download/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/unshare_file/error_email_unverified.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/unshare_file/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/unshare_file/error_no_permission.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy/malformed_path.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_folder_batch/force_async_true.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_folder_batch/conflict_error.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_folder_batch/synchronous_result_success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_folder_batch/autorename_true.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_folder_batch/large_entries.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder_longpoll/list_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder_longpoll/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder_longpoll/reset.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_metadata/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_metadata/success_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_metadata/success_deleted.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_metadata/deleted.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_metadata/success_file.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/delete_batch/multiple_entry_success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/delete_batch/single_entry_success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder_members/success_with_actions.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_folder_members/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/add_folder_member/success_numeric.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/add_folder_member/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/add_folder_member/invalid_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/permanently_delete/invalid_account.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/token_revoke/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_file_members/success_with_actions.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_file_members/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_batch_check/invalid_async_job_id.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/copy_batch_check/complete.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/authenticator/success_with_short_lived_token.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/authenticator/success_with_refresh_token.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_shared_link_with_settings/error_no_permission_for_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_shared_link_with_settings/success_file_with_settings.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_shared_link_with_settings/already_shared.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_shared_link_with_settings/success_file_for_basic_user.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_shared_link_with_settings/success_folder_with_settings.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_shared_link_with_settings/success_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_shared_link_with_settings/error_no_permission_for_file.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_shared_link_with_settings/success_file.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_space_usage/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/restore/invalid_revision.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/restore/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload_session_append_v2/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload_session_append_v2/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload_session_append_v2/offset_error.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/client/refresh_token_on_401.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/client/refresh_token_if_expired.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/client/raise_on_401.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_shared_links/success_file_direct_only.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_shared_links/success_folder.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/list_shared_links/success_file.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload/success_update.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload/too_many_write_operations.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload/success_client_modified.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload/success_add.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload/success_io.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/upload/success_overwrite.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/chunked_uploader/success_with_empty_string.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/chunked_uploader/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_folder/conflict.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_folder/malformed_path.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/create_folder/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_thumbnail/not_found.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/fixtures/vcr_cassettes/get_thumbnail/success.yml Fri, 04 Mar 2022 15:12:27 +0100 +./spec/dropbox_api_v2_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/root_info_spec.rb Sat, 18 Sep 2021 16:32:45 +0200 +./spec/metadata/commit_info_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/folder_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/search_order_by_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/member_action_list_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/upload_session_cursor_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/file_categories_list_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/shared_link_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/file_extensions_list_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/resource_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/search_match_field_options_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/member_permission_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/file_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/file_status_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/search_options_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./spec/metadata/write_mode_spec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./docs/DropboxApi.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/index.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/_index.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/file.rails_setup.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/css/common.css Wed, 29 Sep 2021 23:44:24 +0200 +./docs/css/style.css Wed, 29 Sep 2021 23:44:24 +0200 +./docs/css/full_list.css Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/Endpoints.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/MiddleWare/PathRoot.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/MiddleWare/DecodeResult.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/MiddleWare/Stack.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Client.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/Endpoints/Sharing/AddFolderMember.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Sharing/ShareFolder.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Sharing/ListSharedLinks.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Sharing/ListFileMembers.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Sharing/ListFolderMembers.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Endpoints/Sharing/RevokeSharedLink.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Endpoints/Sharing/UnshareFile.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Endpoints/Sharing/AddFileMember.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/ContentUpload.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Base.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Endpoints/Auth.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/Endpoints/Auth/TokenRevoke.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/RpcNotify.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Endpoints/Sharing.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/Endpoints/Rpc.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Endpoints/Files.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/Endpoints/RpcContent.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Users.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/Endpoints/ContentDownload.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Users/GetCurrentAccount.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Users/GetAccount.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Users/GetAccountBatch.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Users/GetSpaceUsage.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/DeleteBatchCheck.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/CopyBatch.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/GetTemporaryLink.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/ListRevisions.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Endpoints/Files/CreateFileRequest.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Endpoints/Files/GetMetadata.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/GetThumbnailBatch.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/UploadSessionStart.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/PermanentlyDelete.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/ListFolderLongpoll.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/SaveUrl.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/GetThumbnail.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/CopyReferenceGet.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Endpoints/Files/ListFolderContinue.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/CopyBatchCheck.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/UploadSessionFinish.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/DeleteBatch.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/CopyReferenceSave.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/GetPreview.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/Download.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/Search.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/ListFolder.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/Copy.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Endpoints/Files/Move.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Endpoints/Files/Restore.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/Delete.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/Upload.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/CreateFolder.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Endpoints/Files/CreateFolderBatch.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Endpoints/Files/SearchContinue.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/MiddleWare.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/ResultBuilder.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/ChunkedUploader.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/ConnectionBuilder.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Results/CreateFolderBatchResult.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Results/SharedFileMembers.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Results/ListFolderGetLatestCursorResult.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Results/RelocationBatchResultEntry.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Results/Base.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/Results/RelocationBatchResult.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Results/DeleteBatchResult.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Results/CreateFolderBatchResultEntry.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Results/ListFolderLongpollResult.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Results/ShareFolderLaunch.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Results/SaveCopyReferenceResult.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Results/SaveUrlJobStatus.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Results/UploadSessionStart.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Results/GetCopyReferenceResult.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Results/GetTemporaryLinkResult.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Results/ListFolderResult.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Results/SearchResult.html Sat, 07 Dec 2019 19:49:22 +0100 +./docs/DropboxApi/Results/DeleteBatchResultEntry.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Results/ListRevisionsResult.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Results/Search/Match.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Results/VoidResult.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Results/GetThumbnailBatchResult.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Results/ListSharedLinksResult.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Results/CopyBatchResult.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Results/AddFileMemberResultList.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Results/SearchV2Result.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Results/BasicAccountBatch.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Results/Search.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/Results/SaveUrlResult.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Results/SharedFolderMembers.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Metadata.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/Results.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/OptionsValidator.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/Authenticator.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/Errors/DownloadError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/FileMemberActionError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/IsFolderError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/InvalidUrlError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/ListSharedLinksError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/ListFolderError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/InvalidCommentError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/WriteError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/NoWritePermissionError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/ThumbnailError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/ListRevisionsError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/NotAMemberError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/NotFoundError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/GroupDeletedError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/FileAncestorConflictError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/InsufficientSpaceError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/InsideOsxPackageError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/SaveUrlError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/TeamFolderError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/UnsupportedImageError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/InvalidCopyReferenceError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/DeleteError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/CantNestSharedFolderError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/ListFolderLongpollError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/UnsupportedLinkTypeError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/CreateFileRequestError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/CantCopySharedFolderError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/RevokeSharedLinkError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/InsidePublicFolderError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/TooManySharedFolderTargetsError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/ThumbnailBatchError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/ConversionError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/SharedLinkError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/InsideSharedFolderError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/UnsupportedContentError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/InvalidFileError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/ShareFolderError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/BadPathError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/UploadError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/CreateFolderBatchError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/GetCopyReferenceError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/AddFileMemberError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/InvalidEmailError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/RelocationError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/SaveCopyReferenceError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/SharedLinkMalformedError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/WriteConflictError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/GetAccountError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/UploadSessionFinishError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/UnshareFileError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/HttpError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/CreateFolderError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/IsAppFolderError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/InternalError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/InvalidPathError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/TooManyRequestsError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/PollError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/AlreadySharedError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/EmailUnverifiedError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/AddFolderMemberError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/InsufficientPlanError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/ListFolderContinueError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/TooManyMembersError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/InvalidIdError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/InsideAppFolderError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/IsPublicFolderError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/AddMemberSelectorError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/TooManyFilesError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/IsOsxPackageError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/InvalidCursorError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/SharedLinkNotFoundError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/DisallowedNameError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/RestrictedContentError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/BasicError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/CursorNotClosedError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/SharedFolderAccessError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/InvalidSettingsError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/UnsupportedExtensionError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/FileConflictError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/CursorClosedError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/SharedLinkAlreadyExistsError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/GetMetadataError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/UploadWriteFailedError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/GroupNotOnTeamError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/NoPermissionError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/SharedLinkAccessDeniedError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/LookupError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/PreviewError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/SharingFileAccessError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/RateLimitError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/CantMoveFolderIntoItselfError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/SearchError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/SharingUserError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/MalformedPathError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/RestoreError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/RelocationBatchEntryError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/FolderConflictError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Errors/InvalidDropboxIdError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/UnmountedError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/SharePathError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/UnverifiedDropboxId.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/InProgressError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/UploadSessionOffsetError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/TooManyPendingInvitesError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/ContainsSharedFolderError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/InvalidMemberError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/DownloadFailedError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/NotFolderError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/NotFileError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/SettingsError.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Errors/NoAccountError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/UploadSessionLookupError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/InvalidRevisionError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/TooManyWriteOperationsError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Errors/CantShareOutsideTeamError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/IsFileError.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Errors/ExpiredAccessTokenError.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Metadata/FileStatus.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/FileRequest.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/MemberAction.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/SearchOrderBy.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/FileLinkMetadata.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/BasicAccount.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/MemberActionList.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/SearchMatchV2.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/SharedLink.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/Team.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/FileCategory.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/SearchMatchFieldOptions.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Metadata/MetadataV2.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/Base.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/RootInfo.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/FolderLinkMetadata.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/SearchMatchTypeV2.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/UserRootInfo.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/TeamMemberInfo.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/Tag.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxApi/Metadata/SpaceAllocation.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/FileMemberAction.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/Resource.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/Deleted.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/AddMember.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/MediaMetadata.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/ThumbnailBatchResultData.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Metadata/UploadSessionCursor.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Metadata/Dimensions.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/NamespaceId.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/PhotoMetadata.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/MemberPermission.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/ParentFolderAccessInfo.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Metadata/WriteMode.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/AddFileMemberResult.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Metadata/SharedFolderPolicy.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/File.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/CommitInfo.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/AccessLevel.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/Member.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/Name.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/Location.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/SpaceUsage.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/TeamRootInfo.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/LinkPermissions.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/Field.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/SharedLinkMetadata.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Metadata/ThumbnailBatchResultEntry.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/DropboxApi/Metadata/SearchOptions.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/SharedFolder.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/FileCategoriesList.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/FolderSharingInfo.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/FileExtensionsList.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/VideoMetadata.html Wed, 29 Sep 2021 23:44:26 +0200 +./docs/DropboxApi/Metadata/MemberPermissionList.html Wed, 29 Sep 2021 23:44:27 +0200 +./docs/DropboxApi/Metadata/Folder.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/DropboxApi/Metadata/MediaInfo.html Wed, 29 Sep 2021 23:44:25 +0200 +./docs/top-level-namespace.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/js/app.js Wed, 29 Sep 2021 23:44:24 +0200 +./docs/js/full_list.js Wed, 29 Sep 2021 23:44:24 +0200 +./docs/js/jquery.js Wed, 29 Sep 2021 23:44:24 +0200 +./docs/frames.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/class_list.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/file_list.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/DropboxScaffoldBuilder.html Wed, 29 Sep 2021 23:44:28 +0200 +./docs/file.api_coverage.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/method_list.html Wed, 29 Sep 2021 23:44:24 +0200 +./docs/file.README.html Wed, 29 Sep 2021 23:44:24 +0200 +./TODO.md Sun, 27 Feb 2022 14:58:12 +0100 +./README.md Wed, 29 Sep 2021 23:30:17 +0200 +./Rakefile Sun, 07 Feb 2021 18:02:08 +0100 +./dropbox_api.gemspec Fri, 04 Mar 2022 20:04:22 +0100 +./yardoc/endpoint_handler.rb Sun, 07 Feb 2021 18:02:08 +0100 +./yardoc/rspec.rb Sun, 07 Feb 2021 18:02:08 +0100 +./yardoc/templates/default/layout/html/setup.rb Sat, 07 Dec 2019 19:49:22 +0100 +./yardoc/templates/default/method_details/html/specs.erb Sat, 07 Dec 2019 19:49:22 +0100 +./yardoc/templates/default/method_details/setup.rb Sun, 07 Feb 2021 18:02:08 +0100 +./yardoc/templates/default/method_details/text/specs.erb Sat, 07 Dec 2019 19:49:22 +0100 +./yardoc/templates/default/fulldoc/html/css/common.css Sat, 07 Dec 2019 19:49:22 +0100 +./yardoc/helpers/html_helper.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api.rb Fri, 04 Mar 2022 15:31:49 +0100 +./lib/dropbox_api/middleware/decode_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/middleware/stack.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/middleware/path_root.rb Sat, 18 Sep 2021 16:32:45 +0200 +./lib/dropbox_api/connection_builder.rb Sun, 27 Feb 2022 15:05:38 +0100 +./lib/dropbox_api/endpoints/base.rb Wed, 29 Sep 2021 23:30:17 +0200 +./lib/dropbox_api/endpoints/sharing/add_file_member.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/sharing/list_file_members.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/sharing/list_shared_links.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/sharing/share_folder.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/sharing/unshare_file.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/sharing/add_folder_member.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/sharing/list_folder_members.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/auth/token_revoke.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/rpc_content.rb Wed, 29 Sep 2021 23:30:17 +0200 +./lib/dropbox_api/endpoints/rpc_notify.rb Sun, 27 Feb 2022 15:05:38 +0100 +./lib/dropbox_api/endpoints/content_download.rb Wed, 29 Sep 2021 23:30:17 +0200 +./lib/dropbox_api/endpoints/rpc.rb Wed, 29 Sep 2021 23:30:17 +0200 +./lib/dropbox_api/endpoints/file_requests/create_file_request.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/users/get_space_usage.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/users/get_current_account.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/users/get_account_batch.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/users/get_account.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/copy_batch_check.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/upload_session_finish.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/restore.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/list_folder.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/copy_reference_get.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/get_temporary_link.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/get_preview.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/create_folder_batch.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/copy_batch.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/search.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/move.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/search_continue.rb Sat, 18 Sep 2021 16:56:13 +0200 +./lib/dropbox_api/endpoints/files/list_folder_longpoll.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/get_metadata.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/copy_reference_save.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/create_folder.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/list_folder_continue.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/get_thumbnail.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/upload_session_start.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/upload_session_append_v2.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/list_revisions.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/copy.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/save_url.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/create_folder_batch_check.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/permanently_delete.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/delete_batch_check.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/save_url_check_job_status.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/download.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/upload.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/delete_batch.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/files/delete.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/endpoints/content_upload.rb Wed, 29 Sep 2021 23:30:17 +0200 +./lib/dropbox_api/options_validator.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/chunked_uploader.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/base.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/shared_file_members.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/get_copy_reference_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/delete_batch_result_entry.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/create_folder_batch_result_entry.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/void_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/add_file_member_result_list.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/copy_batch_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/relocation_batch_result_entry.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/save_url_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/get_thumbnail_batch_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/list_folder_longpoll_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/share_folder_launch.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/create_folder_batch_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/list_shared_links_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/upload_session_start.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/search/match.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/shared_folder_members.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/basic_account_batch.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/search_v2_result.rb Sat, 18 Sep 2021 16:56:13 +0200 +./lib/dropbox_api/results/list_folder_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/get_temporary_link_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/save_url_job_status.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/delete_batch_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/relocation_batch_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/save_copy_reference_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/results/list_revisions_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/result_builder.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/client.rb Wed, 29 Sep 2021 23:30:17 +0200 +./lib/dropbox_api/authenticator.rb Wed, 29 Sep 2021 23:30:17 +0200 +./lib/dropbox_api/version.rb Fri, 04 Mar 2022 15:38:17 +0100 +./lib/dropbox_api/errors/write_conflict_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/share_folder_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/save_url_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/add_folder_member_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/share_path_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/list_folder_longpoll_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/upload_session_offset_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/upload_write_failed_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/preview_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/unshare_file_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/add_file_member_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/create_file_request_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/list_shared_links_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/basic_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/create_folder_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/add_member_selector_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/too_many_requests_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/shared_folder_access_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/file_member_action_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/list_folder_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/list_folder_continue_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/upload_session_lookup_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/thumbnail_batch_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/write_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/sharing_user_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/settings_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/poll_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/get_copy_reference_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/upload_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/revoke_shared_link_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/create_folder_batch_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/delete_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/get_metadata_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/lookup_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/create_shared_link_with_settings_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/already_shared_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/save_copy_reference_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/search_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/upload_session_finish_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/relocation_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/relocation_batch_entry_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/shared_link_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/http_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/download_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/restore_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/sharing_file_access_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/get_account_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/list_revisions_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/errors/expired_access_token_error.rb Wed, 29 Sep 2021 20:07:19 +0200 +./lib/dropbox_api/errors/thumbnail_error.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/base.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/link_permissions.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/folder_sharing_info.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/upload_session_cursor.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/photo_metadata.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/file_member_action.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/basic_account.rb Sat, 18 Sep 2021 16:32:45 +0200 +./lib/dropbox_api/metadata/tag.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/space_usage.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/file_categories_list.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/write_mode.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/shared_link_metadata.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/root_info.rb Sat, 18 Sep 2021 16:32:45 +0200 +./lib/dropbox_api/metadata/metadata_v2.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/name.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/shared_link.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/video_metadata.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/search_options.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/namespace_id.rb Sat, 18 Sep 2021 16:32:45 +0200 +./lib/dropbox_api/metadata/search_order_by.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/location.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/deleted.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/parent_folder_access_info.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/search_match_v2.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/add_member.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/file.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/user_root_info.rb Sat, 18 Sep 2021 16:32:45 +0200 +./lib/dropbox_api/metadata/access_level.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/member_action.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/team_root_info.rb Sat, 18 Sep 2021 16:32:45 +0200 +./lib/dropbox_api/metadata/file_request.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/member.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/member_permission.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/resource.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/shared_folder_policy.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/space_allocation.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/team.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/search_match_field_options.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/media_info.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/team_member_info.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/folder.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/search_match_type_v2.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/shared_folder.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/file_extensions_list.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/file_status.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/add_file_member_result.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/media_metadata.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/dimensions.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/member_permission_list.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/commit_info.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/folder_link_metadata.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/file_category.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/member_action_list.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/thumbnail_batch_result_data.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/field.rb Sun, 07 Feb 2021 18:02:08 +0100 +./lib/dropbox_api/metadata/file_link_metadata.rb Sun, 07 Feb 2021 18:02:08 +0100 +./Gemfile Sat, 05 Mar 2022 09:45:03 +0100 +./Gemfile.lock Sat, 05 Mar 2022 09:45:15 +0100 +./rails_setup.md Sat, 07 Dec 2019 19:49:22 +0100 diff --git a/doc/css/fonts.css b/doc/css/fonts.css new file mode 100644 index 00000000..57302b51 --- /dev/null +++ b/doc/css/fonts.css @@ -0,0 +1,167 @@ +/* + * Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), + * with Reserved Font Name "Source". All Rights Reserved. Source is a + * trademark of Adobe Systems Incorporated in the United States and/or other + * countries. + * + * This Font Software is licensed under the SIL Open Font License, Version + * 1.1. + * + * This license is copied below, and is also available with a FAQ at: + * http://scripts.sil.org/OFL + */ + +@font-face { + font-family: "Source Code Pro"; + font-style: normal; + font-weight: 400; + src: local("Source Code Pro"), + local("SourceCodePro-Regular"), + url("../fonts/SourceCodePro-Regular.ttf") format("truetype"); +} + +@font-face { + font-family: "Source Code Pro"; + font-style: normal; + font-weight: 700; + src: local("Source Code Pro Bold"), + local("SourceCodePro-Bold"), + url("../fonts/SourceCodePro-Bold.ttf") format("truetype"); +} + +/* + * Copyright (c) 2010, Łukasz Dziedzic (dziedzic@typoland.com), + * with Reserved Font Name Lato. + * + * This Font Software is licensed under the SIL Open Font License, Version + * 1.1. + * + * This license is copied below, and is also available with a FAQ at: + * http://scripts.sil.org/OFL + */ + +@font-face { + font-family: "Lato"; + font-style: normal; + font-weight: 300; + src: local("Lato Light"), + local("Lato-Light"), + url("../fonts/Lato-Light.ttf") format("truetype"); +} + +@font-face { + font-family: "Lato"; + font-style: italic; + font-weight: 300; + src: local("Lato Light Italic"), + local("Lato-LightItalic"), + url("../fonts/Lato-LightItalic.ttf") format("truetype"); +} + +@font-face { + font-family: "Lato"; + font-style: normal; + font-weight: 700; + src: local("Lato Regular"), + local("Lato-Regular"), + url("../fonts/Lato-Regular.ttf") format("truetype"); +} + +@font-face { + font-family: "Lato"; + font-style: italic; + font-weight: 700; + src: local("Lato Italic"), + local("Lato-Italic"), + url("../fonts/Lato-RegularItalic.ttf") format("truetype"); +} + +/* + * ----------------------------------------------------------- + * SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 + * ----------------------------------------------------------- + * + * PREAMBLE + * The goals of the Open Font License (OFL) are to stimulate worldwide + * development of collaborative font projects, to support the font creation + * efforts of academic and linguistic communities, and to provide a free and + * open framework in which fonts may be shared and improved in partnership + * with others. + * + * The OFL allows the licensed fonts to be used, studied, modified and + * redistributed freely as long as they are not sold by themselves. The + * fonts, including any derivative works, can be bundled, embedded, + * redistributed and/or sold with any software provided that any reserved + * names are not used by derivative works. The fonts and derivatives, + * however, cannot be released under any other type of license. The + * requirement for fonts to remain under this license does not apply + * to any document created using the fonts or their derivatives. + * + * DEFINITIONS + * "Font Software" refers to the set of files released by the Copyright + * Holder(s) under this license and clearly marked as such. This may + * include source files, build scripts and documentation. + * + * "Reserved Font Name" refers to any names specified as such after the + * copyright statement(s). + * + * "Original Version" refers to the collection of Font Software components as + * distributed by the Copyright Holder(s). + * + * "Modified Version" refers to any derivative made by adding to, deleting, + * or substituting -- in part or in whole -- any of the components of the + * Original Version, by changing formats or by porting the Font Software to a + * new environment. + * + * "Author" refers to any designer, engineer, programmer, technical + * writer or other person who contributed to the Font Software. + * + * PERMISSION & CONDITIONS + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of the Font Software, to use, study, copy, merge, embed, modify, + * redistribute, and sell modified and unmodified copies of the Font + * Software, subject to the following conditions: + * + * 1) Neither the Font Software nor any of its individual components, + * in Original or Modified Versions, may be sold by itself. + * + * 2) Original or Modified Versions of the Font Software may be bundled, + * redistributed and/or sold with any software, provided that each copy + * contains the above copyright notice and this license. These can be + * included either as stand-alone text files, human-readable headers or + * in the appropriate machine-readable metadata fields within text or + * binary files as long as those fields can be easily viewed by the user. + * + * 3) No Modified Version of the Font Software may use the Reserved Font + * Name(s) unless explicit written permission is granted by the corresponding + * Copyright Holder. This restriction only applies to the primary font name as + * presented to the users. + * + * 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font + * Software shall not be used to promote, endorse or advertise any + * Modified Version, except to acknowledge the contribution(s) of the + * Copyright Holder(s) and the Author(s) or with their explicit written + * permission. + * + * 5) The Font Software, modified or unmodified, in part or in whole, + * must be distributed entirely under this license, and must not be + * distributed under any other license. The requirement for fonts to + * remain under this license does not apply to any document created + * using the Font Software. + * + * TERMINATION + * This license becomes null and void if any of the above conditions are + * not met. + * + * DISCLAIMER + * THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT + * OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL + * DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM + * OTHER DEALINGS IN THE FONT SOFTWARE. + */ + diff --git a/doc/css/rdoc.css b/doc/css/rdoc.css new file mode 100644 index 00000000..2f4dca7e --- /dev/null +++ b/doc/css/rdoc.css @@ -0,0 +1,590 @@ +/* + * "Darkfish" Rdoc CSS + * $Id: rdoc.css 54 2009-01-27 01:09:48Z deveiant $ + * + * Author: Michael Granger + * + */ + +/* vim: ft=css et sw=2 ts=2 sts=2 */ +/* Base Green is: #6C8C22 */ + +* { padding: 0; margin: 0; } + +body { + background: #fafafa; + font-family: Lato, sans-serif; + font-weight: 300; +} + +h1 span, +h2 span, +h3 span, +h4 span, +h5 span, +h6 span { + position: relative; + + display: none; + padding-left: 1em; + line-height: 0; + vertical-align: baseline; + font-size: 10px; +} + +h1 span { top: -1.3em; } +h2 span { top: -1.2em; } +h3 span { top: -1.0em; } +h4 span { top: -0.8em; } +h5 span { top: -0.5em; } +h6 span { top: -0.5em; } + +h1:hover span, +h2:hover span, +h3:hover span, +h4:hover span, +h5:hover span, +h6:hover span { + display: inline; +} + +:link, +:visited { + color: #6C8C22; + text-decoration: none; +} + +:link:hover, +:visited:hover { + border-bottom: 1px dotted #6C8C22; +} + +code, +pre { + font-family: "Source Code Pro", Monaco, monospace; +} + +/* @group Generic Classes */ + +.initially-hidden { + display: none; +} + +#search-field { + width: 98%; + background: white; + border: none; + height: 1.5em; + -webkit-border-radius: 4px; + -moz-border-radius: 4px; + border-radius: 4px; + text-align: left; +} +#search-field:focus { + background: #f1edba; +} +#search-field:-moz-placeholder, +#search-field::-webkit-input-placeholder { + font-weight: bold; + color: #666; +} + +.missing-docs { + font-size: 120%; + background: white url(images/wrench_orange.png) no-repeat 4px center; + color: #ccc; + line-height: 2em; + border: 1px solid #d00; + opacity: 1; + padding-left: 20px; + text-indent: 24px; + letter-spacing: 3px; + font-weight: bold; + -webkit-border-radius: 5px; + -moz-border-radius: 5px; +} + +.target-section { + border: 2px solid #dcce90; + border-left-width: 8px; + padding: 0 1em; + background: #fff3c2; +} + +/* @end */ + +/* @group Index Page, Standalone file pages */ +.table-of-contents ul { + margin: 1em; + list-style: none; +} + +.table-of-contents ul ul { + margin-top: 0.25em; +} + +.table-of-contents ul :link, +.table-of-contents ul :visited { + font-size: 16px; +} + +.table-of-contents li { + margin-bottom: 0.25em; +} + +.table-of-contents li .toc-toggle { + width: 16px; + height: 16px; + background: url(images/add.png) no-repeat; +} + +.table-of-contents li .toc-toggle.open { + background: url(images/delete.png) no-repeat; +} + +/* @end */ + +/* @group Top-Level Structure */ + +nav { + float: left; + width: 260px; + font-family: Helvetica, sans-serif; + font-size: 14px; +} + +main { + display: block; + margin: 0 2em 5em 260px; + padding-left: 20px; + min-width: 340px; + font-size: 16px; +} + +main h1, +main h2, +main h3, +main h4, +main h5, +main h6 { + font-family: Helvetica, sans-serif; +} + +.table-of-contents main { + margin-left: 2em; +} + +#validator-badges { + clear: both; + margin: 1em 1em 2em; + font-size: smaller; +} + +/* @end */ + +/* @group navigation */ +nav { + margin-bottom: 1em; +} + +nav .nav-section { + margin-top: 2em; + border-top: 2px solid #aaa; + font-size: 90%; + overflow: hidden; +} + +nav h2 { + margin: 0; + padding: 2px 8px 2px 8px; + background-color: #e8e8e8; + color: #555; + font-size: 125%; + text-align: center; +} + +nav h3, +#table-of-contents-navigation { + margin: 0; + padding: 2px 8px 2px 8px; + text-align: right; + background-color: #e8e8e8; + color: #555; +} + +nav ul, +nav dl, +nav p { + padding: 4px 8px 0; + list-style: none; +} + +#project-navigation .nav-section { + margin: 0; + border-top: 0; +} + +#home-section h2 { + text-align: center; +} + +#table-of-contents-navigation { + font-size: 1.2em; + font-weight: bold; + text-align: center; +} + +#search-section { + margin-top: 0; + border-top: 0; +} + +#search-field-wrapper { + border-top: 1px solid #aaa; + border-bottom: 1px solid #aaa; + padding: 3px 8px; + background-color: #e8e8e8; + color: #555; +} + +ul.link-list li { + white-space: nowrap; + line-height: 1.4em; +} + +ul.link-list .type { + font-size: 8px; + text-transform: uppercase; + color: white; + background: #969696; + padding: 2px 4px; + -webkit-border-radius: 5px; +} + +.calls-super { + background: url(images/arrow_up.png) no-repeat right center; +} + +/* @end */ + +/* @group Documentation Section */ +main { + color: #333; +} + +main > h1:first-child, +main > h2:first-child, +main > h3:first-child, +main > h4:first-child, +main > h5:first-child, +main > h6:first-child { + margin-top: 0px; +} + +main sup { + vertical-align: super; + font-size: 0.8em; +} + +/* The heading with the class name */ +main h1[class] { + margin-top: 0; + margin-bottom: 1em; + font-size: 2em; + color: #6C8C22; +} + +main h1 { + margin: 2em 0 0.5em; + font-size: 1.7em; +} + +main h2 { + margin: 2em 0 0.5em; + font-size: 1.5em; +} + +main h3 { + margin: 2em 0 0.5em; + font-size: 1.2em; +} + +main h4 { + margin: 2em 0 0.5em; + font-size: 1.1em; +} + +main h5 { + margin: 2em 0 0.5em; + font-size: 1em; +} + +main h6 { + margin: 2em 0 0.5em; + font-size: 1em; +} + +main p { + margin: 0 0 0.5em; + line-height: 1.4em; +} + +main pre { + margin: 1.2em 0.5em; + padding: 1em; + font-size: 0.8em; +} + +main hr { + margin: 1.5em 1em; + border: 2px solid #ddd; +} + +main blockquote { + margin: 0 2em 1.2em 1.2em; + padding-left: 0.5em; + border-left: 2px solid #ddd; +} + +main ol, +main ul { + margin: 1em 2em; +} + +main li > p { + margin-bottom: 0.5em; +} + +main dl { + margin: 1em 0.5em; +} + +main dt { + margin-bottom: 0.5em; + font-weight: bold; +} + +main dd { + margin: 0 1em 1em 0.5em; +} + +main header h2 { + margin-top: 2em; + border-width: 0; + border-top: 4px solid #bbb; + font-size: 130%; +} + +main header h3 { + margin: 2em 0 1.5em; + border-width: 0; + border-top: 3px solid #bbb; + font-size: 120%; +} + +.documentation-section-title { + position: relative; +} +.documentation-section-title .section-click-top { + position: absolute; + top: 6px; + left: 12px; + font-size: 10px; + color: #9b9877; + visibility: hidden; + padding-left: 0.5px; +} + +.documentation-section-title:hover .section-click-top { + visibility: visible; +} + +.constants-list > dl { + margin: 1em 0 2em; + border: 0; +} + +.constants-list > dl dt { + margin-bottom: 0.75em; + padding-left: 0; + font-family: "Source Code Pro", Monaco, monospace; + font-size: 110%; +} + +.constants-list > dl dt a { + color: inherit; +} + +.constants-list > dl dd { + margin: 0 0 2em 0; + padding: 0; + color: #666; +} + +.documentation-section h2 { + position: relative; +} + +.documentation-section h2 a { + position: absolute; + top: 8px; + right: 10px; + font-size: 12px; + color: #9b9877; + visibility: hidden; +} + +.documentation-section h2:hover a { + visibility: visible; +} + +/* @group Method Details */ + +main .method-source-code { + display: none; +} + +main .method-description .method-calls-super { + color: #333; + font-weight: bold; +} + +main .method-detail { + margin-bottom: 2.5em; + cursor: pointer; +} + +main .method-detail:target { + margin-left: -10px; + border-left: 10px solid #f1edba; +} + +main .method-heading { + position: relative; + font-family: "Source Code Pro", Monaco, monospace; + font-size: 110%; + font-weight: bold; + color: #333; +} +main .method-heading :link, +main .method-heading :visited { + color: inherit; +} +main .method-click-advice { + position: absolute; + top: 2px; + right: 5px; + font-size: 12px; + color: #9b9877; + visibility: hidden; + padding-right: 20px; + line-height: 20px; + background: url(images/zoom.png) no-repeat right top; +} +main .method-heading:hover .method-click-advice { + visibility: visible; +} + +main .method-alias .method-heading { + color: #666; +} + +main .method-description, +main .aliases { + margin-top: 0.75em; + color: #333; +} + +main .aliases { + padding-top: 4px; + font-style: italic; + cursor: default; +} +main .method-description ul { + margin-left: 1.5em; +} + +main #attribute-method-details .method-detail:hover { + background-color: transparent; + cursor: default; +} +main .attribute-access-type { + text-transform: uppercase; + padding: 0 1em; +} +/* @end */ + +/* @end */ + +/* @group Source Code */ + +pre { + margin: 0.5em 0; + border: 1px dashed #999; + padding: 0.5em; + background: #262626; + color: white; + overflow: auto; +} + +.ruby-constant { color: #7fffd4; background: transparent; } +.ruby-keyword { color: #00ffff; background: transparent; } +.ruby-ivar { color: #eedd82; background: transparent; } +.ruby-operator { color: #00ffee; background: transparent; } +.ruby-identifier { color: #ffdead; background: transparent; } +.ruby-node { color: #ffa07a; background: transparent; } +.ruby-comment { color: #dc0000; background: transparent; } +.ruby-regexp { color: #ffa07a; background: transparent; } +.ruby-value { color: #7fffd4; background: transparent; } + +/* @end */ + + +/* @group search results */ +#search-results { + font-family: Lato, sans-serif; + font-weight: 300; +} + +#search-results .search-match { + font-family: Helvetica, sans-serif; + font-weight: normal; +} + +#search-results .search-selected { + background: #e8e8e8; + border-bottom: 1px solid transparent; +} + +#search-results li { + list-style: none; + border-bottom: 1px solid #aaa; + margin-bottom: 0.5em; +} + +#search-results li:last-child { + border-bottom: none; + margin-bottom: 0; +} + +#search-results li p { + padding: 0; + margin: 0.5em; +} + +#search-results .search-namespace { + font-weight: bold; +} + +#search-results li em { + background: yellow; + font-style: normal; +} + +#search-results pre { + margin: 0.5em; + font-family: "Source Code Pro", Monaco, monospace; +} + +/* @end */ + diff --git a/doc/docs/DropboxApi/Authenticator_html.html b/doc/docs/DropboxApi/Authenticator_html.html new file mode 100644 index 00000000..facd8725 --- /dev/null +++ b/doc/docs/DropboxApi/Authenticator_html.html @@ -0,0 +1,883 @@ + + + + + + +Authenticator.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Authenticator
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Authenticator";
+relpath = '../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../_index.html">Index (A)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+   &raquo; 
+  <span class="title">Authenticator</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Authenticator
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">OAuth2::Client</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">OAuth2::Client</li>
+
+          <li class="next">DropboxApi::Authenticator</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/authenticator.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client_id, client_secret)  &#x21d2; Authenticator </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of Authenticator.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(client_id, client_secret)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Authenticator (class)">Authenticator</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of Authenticator.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

6 7 8 9 10 11</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/authenticator.rb', line 6</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_client_id'>client_id</span><span +class='comma'>,</span> <span class='id identifier +rubyid_client_secret'>client_secret</span><span +class='rparen'>)</span>

+ +
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span><span class='comma'>,</span> <span class='id identifier rubyid_client_secret'>client_secret</span><span class='comma'>,</span> <span class='lbrace'>{</span>
+  <span class='label'>authorize_url:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://www.dropbox.com/oauth2/authorize</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+  <span class='label'>token_url:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://api.dropboxapi.com/oauth2/token</span><span class='tstring_end'>&#39;</span></span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/ChunkedUploader_html.html b/doc/docs/DropboxApi/ChunkedUploader_html.html new file mode 100644 index 00000000..212c82b7 --- /dev/null +++ b/doc/docs/DropboxApi/ChunkedUploader_html.html @@ -0,0 +1,1035 @@ + + + + + + +ChunkedUploader.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::ChunkedUploader
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::ChunkedUploader";
+relpath = '../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+   &raquo; 
+  <span class="title">ChunkedUploader</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::ChunkedUploader
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::ChunkedUploader</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/chunked_uploader.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#finish-instance_method" title="#finish (instance method)">#<strong>finish</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client, path, i_stream, options = {})  &#x21d2; ChunkedUploader </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of ChunkedUploader.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#start-instance_method" title="#start (instance method)">#<strong>start</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#upload-instance_method" title="#upload (instance method)">#<strong>upload</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(client, path, i_stream, options = {})  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::ChunkedUploader (class)">ChunkedUploader</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of ChunkedUploader.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

6 7 8 9 10 11 12 13</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/chunked_uploader.rb', line 6</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_client'>client</span><span +class='comma'>,</span> <span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_i_stream'>i_stream</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@chunk_size</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:chunk_size</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='int'>4</span> <span class='op'>*</span> <span class='int'>1024</span> <span class='op'>*</span> <span class='int'>1024</span> <span class='comment'># 4 MiB
+ +

</span>

+ +
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
+<span class='ivar'>@i_stream</span> <span class='op'>=</span> <span class='id identifier rubyid_i_stream'>i_stream</span>
+
+<span class='id identifier rubyid_init_commit_info'>init_commit_info</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="finish-instance_method">
+
+  #<strong>finish</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

32 33 34</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/chunked_uploader.rb', line 32</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_finish'>finish</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_upload_session_finish'>upload_session_finish</span> <span class='ivar'>@cursor</span><span class='comma'>,</span> <span class='ivar'>@commit_info</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="start-instance_method">
+
+  #<strong>start</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

15 16 17 18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/chunked_uploader.rb', line 15</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_start'>start</span>

+ +
<span class='id identifier rubyid_chunk'>chunk</span> <span class='op'>=</span> <span class='ivar'>@i_stream</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span> <span class='ivar'>@chunk_size</span>
+<span class='id identifier rubyid_chunk'>chunk</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_chunk'>chunk</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+
+<span class='ivar'>@cursor</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_upload_session_start'>upload_session_start</span> <span class='id identifier rubyid_chunk'>chunk</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="upload-instance_method">
+
+  #<strong>upload</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

22 23 24 25 26 27 28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/chunked_uploader.rb', line 22</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_upload'>upload</span>

+ +
<span class='id identifier rubyid_loop'>loop</span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_chunk'>chunk</span> <span class='op'>=</span> <span class='ivar'>@i_stream</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span> <span class='ivar'>@chunk_size</span>
+  <span class='kw'>break</span> <span class='kw'>if</span> <span class='id identifier rubyid_chunk'>chunk</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+
+  <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_upload_session_append_v2'>upload_session_append_v2</span> <span class='ivar'>@cursor</span><span class='comma'>,</span> <span class='id identifier rubyid_chunk'>chunk</span>
+  <span class='kw'>break</span> <span class='kw'>if</span> <span class='id identifier rubyid_chunk'>chunk</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>&lt;</span> <span class='ivar'>@chunk_size</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Client_html.html b/doc/docs/DropboxApi/Client_html.html new file mode 100644 index 00000000..497cbe20 --- /dev/null +++ b/doc/docs/DropboxApi/Client_html.html @@ -0,0 +1,16218 @@ + + + + + + +Client.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Client
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Client";
+relpath = '../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+   &raquo; 
+  <span class="title">Client</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Client
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::Client</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/client.rb<span class="defines">,<br />
+lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb</span>
+ +

</dd>

+ +
</dl>
+ +

</div>

+ +
  <h2>
+    virtual
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#upload_by_chunks-instance_method" title="#upload_by_chunks (instance method)">#<strong>upload_by_chunks</strong>(path, content, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Creates a new file using the <em>upload session</em> endpoints.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+  <h2>
+    sharing
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#add_file_member-instance_method" title="#add_file_member (instance method)">#<strong>add_file_member</strong>(file, members, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Adds specified members to a file.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#add_folder_member-instance_method" title="#add_folder_member (instance method)">#<strong>add_folder_member</strong>(folder_id, members, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#create_shared_link_with_settings-instance_method" title="#create_shared_link_with_settings (instance method)">#<strong>create_shared_link_with_settings</strong>(path, settings = {})  &#x21d2; DropboxApi::Metadata::SharedLinkMetadata </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Create a shared link with custom settings.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_shared_link_metadata-instance_method" title="#get_shared_link_metadata (instance method)">#<strong>get_shared_link_metadata</strong>(preview_link, options = {})  &#x21d2; SharedFileMembers </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get the Metadata for a shared link.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_file_members-instance_method" title="#list_file_members (instance method)">#<strong>list_file_members</strong>(file_id, actions = [], options = {})  &#x21d2; SharedFileMembers </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Use to obtain the members who have been invited to a file, both inherited and uninherited members.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_folder_members-instance_method" title="#list_folder_members (instance method)">#<strong>list_folder_members</strong>(folder_id, actions = [], options = {})  &#x21d2; SharedFolderMembers </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns shared folder membership by its folder ID.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_shared_links-instance_method" title="#list_shared_links (instance method)">#<strong>list_shared_links</strong>(options = {})  &#x21d2; ListSharedLinksResult </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>List shared links of this user.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#revoke_shared_link-instance_method" title="#revoke_shared_link (instance method)">#<strong>revoke_shared_link</strong>(url)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Revoke a shared link.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#share_folder-instance_method" title="#share_folder (instance method)">#<strong>share_folder</strong>(path, options = {})  &#x21d2; DropboxApi::Results::ShareFolderLaunch </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Share a folder with collaborators.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#unshare_file-instance_method" title="#unshare_file (instance method)">#<strong>unshare_file</strong>(file)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Remove all members from this file.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+  <h2>
+    files
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#copy-instance_method" title="#copy (instance method)">#<strong>copy</strong>(from, to)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Copy a file or folder to a different location in the user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#copy_batch-instance_method" title="#copy_batch (instance method)">#<strong>copy_batch</strong>(entries, options = {})  &#x21d2; String, Array </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Copy multiple files or folders to different locations at once in the user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#copy_batch_check-instance_method" title="#copy_batch_check (instance method)">#<strong>copy_batch_check</strong>(async_job_id)  &#x21d2; :in_progress, Array </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for <span class='object_link'><a href="#copy_batch-instance_method" title="DropboxApi::Client#copy_batch (method)">#copy_batch</a></span>.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#copy_reference_get-instance_method" title="#copy_reference_get (instance method)">#<strong>copy_reference_get</strong>(path)  &#x21d2; DropboxApi::Results::GetCopyReferenceResult </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get a copy reference to a file or folder.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#copy_reference_save-instance_method" title="#copy_reference_save (instance method)">#<strong>copy_reference_save</strong>(copy_reference, path)  &#x21d2; DropboxApi::Results::SaveCopyReferenceResult </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Save a copy reference returned by <span class='object_link'><a href="#copy_reference_get-instance_method" title="DropboxApi::Client#copy_reference_get (method)">#copy_reference_get</a></span> to the user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#create_file_request-instance_method" title="#create_file_request (instance method)">#<strong>create_file_request</strong>(title, destination)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Create a file request for a given path.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#create_folder-instance_method" title="#create_folder (instance method)">#<strong>create_folder</strong>(path)  &#x21d2; DropboxApi::Metadata::Folder </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Create a folder at a given path.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#create_folder_batch-instance_method" title="#create_folder_batch (instance method)">#<strong>create_folder_batch</strong>(paths, options = {})  &#x21d2; String, Array </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Create multiple folders at once.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#create_folder_batch_check-instance_method" title="#create_folder_batch_check (instance method)">#<strong>create_folder_batch_check</strong>(async_job_id)  &#x21d2; Array </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for create_folder_batch.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(path, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Delete the file or folder at a given path.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#delete_batch-instance_method" title="#delete_batch (instance method)">#<strong>delete_batch</strong>(entries)  &#x21d2; String, Array </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Delete multiple files/folders at once.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#delete_batch_check-instance_method" title="#delete_batch_check (instance method)">#<strong>delete_batch_check</strong>(async_job_id)  &#x21d2; :in_progress, Array </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for delete_batch.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#download-instance_method" title="#download (instance method)">#<strong>download</strong>(path, &amp;block)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Download a file from a user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_metadata-instance_method" title="#get_metadata (instance method)">#<strong>get_metadata</strong>(path, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the metadata for a file or folder.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_preview-instance_method" title="#get_preview (instance method)">#<strong>get_preview</strong>(path, &amp;block)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get a preview for a file.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_temporary_link-instance_method" title="#get_temporary_link (instance method)">#<strong>get_temporary_link</strong>(path)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get a temporary link to stream content of a file.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_thumbnail-instance_method" title="#get_thumbnail (instance method)">#<strong>get_thumbnail</strong>(path, options = {}, &amp;block)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get a thumbnail for an image.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_thumbnail_batch-instance_method" title="#get_thumbnail_batch (instance method)">#<strong>get_thumbnail_batch</strong>(paths, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get a thumbnails for a batch of images.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_folder-instance_method" title="#list_folder (instance method)">#<strong>list_folder</strong>(path, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the contents of a folder.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_folder_continue-instance_method" title="#list_folder_continue (instance method)">#<strong>list_folder_continue</strong>(cursor)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Once a cursor has been retrieved from <code>list_folder</code>, use this to paginate through all files and retrieve updates to the folder.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_folder_get_latest_cursor-instance_method" title="#list_folder_get_latest_cursor (instance method)">#<strong>list_folder_get_latest_cursor</strong>(options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>A way to quickly get a cursor for the folder&#39;s state.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_folder_longpoll-instance_method" title="#list_folder_longpoll (instance method)">#<strong>list_folder_longpoll</strong>(cursor, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>A longpoll endpoint to wait for changes on an account.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_revisions-instance_method" title="#list_revisions (instance method)">#<strong>list_revisions</strong>(path, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Return revisions of a file.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#move-instance_method" title="#move (instance method)">#<strong>move</strong>(from, to, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Move a file or folder to a different location in the user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#permanently_delete-instance_method" title="#permanently_delete (instance method)">#<strong>permanently_delete</strong>(path, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Permanently delete the file or folder at a given path.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#restore-instance_method" title="#restore (instance method)">#<strong>restore</strong>(path, rev)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Restore a file to a specific revision.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#save_url-instance_method" title="#save_url (instance method)">#<strong>save_url</strong>(path, url)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Save a specified URL into a file in user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#save_url_check_job_status-instance_method" title="#save_url_check_job_status (instance method)">#<strong>save_url_check_job_status</strong>(job_id)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Check the status of a <code>save_url</code> job.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#search-instance_method" title="#search (instance method)">#<strong>search</strong>(query, options = nil, match_field_options = nil)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Searches for files and folders.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#search_continue-instance_method" title="#search_continue (instance method)">#<strong>search_continue</strong>(cursor)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>search:2.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#upload-instance_method" title="#upload (instance method)">#<strong>upload</strong>(path, content, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Creates a new file.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#upload_session_append_v2-instance_method" title="#upload_session_append_v2 (instance method)">#<strong>upload_session_append_v2</strong>(cursor, content, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Append more data to an upload session.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#upload_session_finish-instance_method" title="#upload_session_finish (instance method)">#<strong>upload_session_finish</strong>(cursor, commit, content = nil)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Finish an upload session and save the uploaded data to the given file path.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#upload_session_start-instance_method" title="#upload_session_start (instance method)">#<strong>upload_session_start</strong>(content, options = {})  &#x21d2; DropboxApi::Metadata::UploadSessionCursor </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+  <h2>
+    users
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_account-instance_method" title="#get_account (instance method)">#<strong>get_account</strong>(account_id)  &#x21d2; BasicAccount </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get information about a user&#39;s account.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_account_batch-instance_method" title="#get_account_batch (instance method)">#<strong>get_account_batch</strong>(account_ids)  &#x21d2; Array&lt;BasicAccount&gt; </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get information about multiple user accounts.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_current_account-instance_method" title="#get_current_account (instance method)">#<strong>get_current_account</strong>  &#x21d2; BasicAccount </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get information about the current user&#39;s account.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_space_usage-instance_method" title="#get_space_usage (instance method)">#<strong>get_space_usage</strong>  &#x21d2; SpaceUsage </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get the space usage information for the current user&#39;s account.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+  <h2>
+    auth
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#token_revoke-instance_method" title="#token_revoke (instance method)">#<strong>token_revoke</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Revoke the access token for the current account.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(oauth_bearer = ENV[&#39;DROPBOX_OAUTH_BEARER&#39;], access_token: nil, on_token_refreshed: nil)  &#x21d2; Client </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of Client.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#middleware-instance_method" title="#middleware (instance method)">#<strong>middleware</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#namespace_id-instance_method" title="#namespace_id (instance method)">#<strong>namespace_id</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#namespace_id=-instance_method" title="#namespace_id= (instance method)">#<strong>namespace_id=</strong>(value)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
</ul>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(oauth_bearer = ENV[&#39;DROPBOX_OAUTH_BEARER&#39;], access_token: nil, on_token_refreshed: nil)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Client (class)">Client</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of Client.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/client.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span>

+ +
<span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span> <span class='op'>=</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DROPBOX_OAUTH_BEARER</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
+<span class='label'>access_token:</span> <span class='kw'>nil</span><span class='comma'>,</span>
+<span class='label'>on_token_refreshed:</span> <span class='kw'>nil</span>
+ +

<span class='rparen'>)</span>

+ +
<span class='kw'>if</span> <span class='id identifier rubyid_access_token'>access_token</span>
+  <span class='ivar'>@connection_builder</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ConnectionBuilder.html" title="DropboxApi::ConnectionBuilder (class)">ConnectionBuilder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ConnectionBuilder.html#initialize-instance_method" title="DropboxApi::ConnectionBuilder#initialize (method)">new</a></span></span><span class='lparen'>(</span>
+    <span class='label'>access_token:</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span>
+    <span class='label'>on_token_refreshed:</span> <span class='id identifier rubyid_on_token_refreshed'>on_token_refreshed</span>
+  <span class='rparen'>)</span>
+<span class='kw'>elsif</span> <span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span>
+  <span class='ivar'>@connection_builder</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ConnectionBuilder.html" title="DropboxApi::ConnectionBuilder (class)">ConnectionBuilder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ConnectionBuilder.html#initialize-instance_method" title="DropboxApi::ConnectionBuilder#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span><span class='rparen'>)</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Either oauth_bearer or access_token should be set</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="add_file_member-instance_method">
+
+  #<strong>add_file_member</strong>(file, members, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Adds specified members to a file.</p>
+ +

<p>The members parameter can be an Array or +a single member element. Each element is represented by either a +String or a <span class='object_link'><a +href=“Metadata/Member.html” title=“DropboxApi::Metadata::Member +(class)”>Metadata::Member</a></span> object. You can +identify a member using his email or a Dropbox ID.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>file</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>File to which to add members. It can be a path or
+ +

an ID such as id:3kmLmQFnf1AAAAAAAAAAAw.</p> +</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>members</span>
+
+    <span class='type'></span>
+
+    &mdash;
+    <div class='inline'><p>Members to add. Note
+ +

that even if an email address is given, this may result in a user being +directy added to the membership if that email is the user&#39;s main +account email.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">quiet</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Whether added members should be notified
+ +

via email and device notifications of their invite. The default for this +field is false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">custom_message</span>
+  <span class="type">(<tt>String</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Message to send to added members
+ +

in their invitation. This field is optional.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">access_level</span>
+  <span class="type">(<tt>AccessLevel</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>AccessLevel union object,
+ +

describing what access level we want to give new members. The default for +this is :viewer.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">add_message_as_comment</span>
+  <span class="type">(<tt>String</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Optional message to
+ +

display to added members in their invitation. This field is +optional.</p> </div>

+ +
      </li>
+
+  </ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li><span class='object_link'><a href="Metadata/Member.html" title="DropboxApi::Metadata::Member (class)">Metadata::Member</a></span></li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      adds 1 member to a file
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10 11 12 13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_file_member_spec.rb', line 34</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/bsd.pdf</span><span +class='tstring_end'>&#39;</span></span> <span +class='id identifier rubyid_members'>members</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_add_file_member'>add_file_member</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>a@test.com</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_members'>members</span><span +class='rparen'>)</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results/AddFileMemberResultList.html" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</a></span></span><span class='rparen'>)</span>
+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_members'>members</span><span +class='period'>.</span><span class='id identifier +rubyid_first'>first</span><span +class='rparen'>)</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/AddFileMemberResult.html" title="DropboxApi::Metadata::AddFileMemberResult (class)">AddFileMemberResult</a></span></span><span class='rparen'>)</span>
+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_members'>members</span><span +class='period'>.</span><span class='id identifier +rubyid_first'>first</span><span +class='period'>.</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='symbol'>:viewer</span><span class='rparen'>)</span></pre>
+          </td>
+        </tr>
+      </table>
+    </li>
+
+    <li>
+      adds 2 members to a file
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

19 20 21 22 23 24 25 26 27</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_file_member_spec.rb', line 34</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/bsd.pdf</span><span +class='tstring_end'>&#39;</span></span> <span +class='id identifier rubyid_members'>members</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_add_file_member'>add_file_member</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='comma'>,</span> <span +class='qwords_beg'>%w(</span><span +class='tstring_content'>a@test.com</span><span +class='words_sep'> </span><span +class='tstring_content'>b@test.com</span><span +class='tstring_end'>)</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_members'>members</span><span +class='rparen'>)</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results/AddFileMemberResultList.html" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</a></span></span><span class='rparen'>)</span>
+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_members'>members</span><span +class='period'>.</span><span class='id identifier +rubyid_map'>map</span><span +class='lparen'>(</span><span +class='op'>&amp;</span><span +class='symbol'>:class</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_uniq'>uniq</span><span +class='rparen'>)</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/AddFileMemberResult.html" title="DropboxApi::Metadata::AddFileMemberResult (class)">AddFileMemberResult</a></span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_members'>members</span><span +class='period'>.</span><span class='id identifier +rubyid_map'>map</span><span +class='lparen'>(</span><span +class='op'>&amp;</span><span +class='symbol'>:result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_uniq'>uniq</span><span +class='rparen'>)</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:viewer</span><span class='rbracket'>]</span><span class='rparen'>)</span></pre>
+          </td>
+        </tr>
+      </table>
+    </li>
+
+    <li>
+      adds a member with comment
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

31 32 33 34 35 36 37</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_file_member_spec.rb', line 34</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/bsd.pdf</span><span +class='tstring_end'>&#39;</span></span> <span +class='id identifier rubyid_members'>members</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_add_file_member'>add_file_member</span> <span +class='id identifier rubyid_file'>file</span><span +class='comma'>,</span>

+ +
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>a@test.com</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+<span class='label'>custom_message:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>See my file down here.</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_members'>members</span><span +class='rparen'>)</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results/AddFileMemberResultList.html" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</a></span></span><span class='rparen'>)</span></pre>
+          </td>
+        </tr>
+      </table>
+    </li>
+
+    <li>
+      adds a member with access level
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

41 42 43 44 45 46 47 48</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_file_member_spec.rb', line 34</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/bsd.pdf</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='comment'># Using :viewer_no_comment as access +level will fail with no_permission. </span><span class='id +identifier rubyid_expect'>expect</span> <span +class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_add_file_member'>add_file_member</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span>
+                        <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>a@test.com</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+                        <span class='label'>access_level:</span> <span class='symbol'>:viewer_no_comment</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NoPermissionError.html” +title=“DropboxApi::Errors::NoPermissionError +(class)”>NoPermissionError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

34 35 36 37 38 39 40 41 42 43 44 45</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/add_file_member.rb', line 34</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:add_file_member</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_file'>file</span><span +class='comma'>,</span> <span class='id identifier +rubyid_members'>members</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='comma'>,</span> <span class='symbol'>:custom_message</span><span class='comma'>,</span> <span class='symbol'>:access_level</span><span class='comma'>,</span> <span class='symbol'>:add_message_as_comment</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:custom_message</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:access_level</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:viewer</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:add_message_as_comment</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>file:</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span>
+  <span class='label'>members:</span> <span class='id identifier rubyid_build_members_param'>build_members_param</span><span class='lparen'>(</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="add_folder_member-instance_method">
+
+  #<strong>add_folder_member</strong>(folder_id, members, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Allows an owner or editor (if the ACL update policy allows) of a shared
+ +

folder to add another member.</p>

+ +

<p>For the new member to get access to all the functionality for this +folder, you will need to call mount_folder on their +behalf.</p>

+ +

<p>Apps must have full Dropbox access to use this endpoint.</p>

+ +

<p>The members parameter can be an Array or +a single member element. Each element is represented by either a +String or a <span class='object_link'><a +href=“Metadata/AddMember.html” title=“DropboxApi::Metadata::AddMember +(class)”>Metadata::AddMember</a></span> object. This +parameter can be just a string with an email.</p>

+ +

<p>You can also build a <span class='object_link'><a +href=“Metadata/AddMember.html” title=“DropboxApi::Metadata::AddMember +(class)”>Metadata::AddMember</a></span> object and use it in +the members parameter, this allows custom options for each +member.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+    <pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
+ +

<span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_add_folder_member'>add_folder_member</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>1363389221</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>somebody@test.com</span><span +class='tstring_end'>&quot;</span></span></code></pre>

+ +
</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>folder_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The ID for the shared folder.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>members</span>
+
+    <span class='type'>(<tt>Array&lt;AddMember,String&gt;</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The intended list of members to
+ +

add. Added members will receive invites to join the shared +folder.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">quiet</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Whether added members should be notified
+ +

via email and device notifications of their invite. The default for this +field is False.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">custom_message</span>
+  <span class="type">(<tt>String</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Optional message to display to
+ +

added members in their invitation. This field is optional.</p> +</div>

+ +
      </li>
+
+  </ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li><span class='object_link'><a href="Metadata/AddMember.html" title="DropboxApi::Metadata::AddMember (class)">Metadata::AddMember</a></span></li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      shares the folder
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39</span>
+ +

<span class='id identifier +rubyid_folder_id'>folder_id</span> <span +class='op'>=</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>1236358158</span><span +class='tstring_end'>&#39;</span></span> <span +class='id identifier rubyid_folder'>folder</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_add_folder_member'>add_folder_member</span> <span +class='id identifier +rubyid_folder_id'>folder_id</span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>somebody@test.com</span><span +class='tstring_end'>&#39;</span></span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  shares the folder, if the folder id is a number
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39</span>
+ +

<span class='id identifier +rubyid_folder_id'>folder_id</span> <span +class='op'>=</span> <span +class='int'>1236358158</span> <span class='id +identifier rubyid_folder'>folder</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_add_folder_member'>add_folder_member</span> <span +class='id identifier +rubyid_folder_id'>folder_id</span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>somebody@test.com</span><span +class='tstring_end'>&#39;</span></span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  shares the folder, if the param is an AddMember object
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

21 22</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39</span>
+ +

<span class='id identifier +rubyid_folder_id'>folder_id</span> <span +class='op'>=</span> <span +class='int'>1236358158</span> <span class='id +identifier rubyid_folder'>folder</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_add_folder_member'>add_folder_member</span> <span +class='id identifier +rubyid_folder_id'>folder_id</span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>somebody@test.com</span><span +class='tstring_end'>&#39;</span></span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  shares the folder, if the member param is an email string
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

28 29</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39</span>
+ +

<span class='id identifier +rubyid_folder_id'>folder_id</span> <span +class='op'>=</span> <span +class='int'>1236358158</span> <span class='id +identifier rubyid_folder'>folder</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_add_folder_member'>add_folder_member</span> <span +class='id identifier +rubyid_folder_id'>folder_id</span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>somebody@test.com</span><span +class='tstring_end'>&#39;</span></span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  fails with an invalid folder id
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

35 36 37 38 39</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39</span>
+ +

<span class='id identifier +rubyid_folder_id'>folder_id</span> <span +class='op'>=</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>xxx</span><span +class='tstring_end'>&#39;</span></span> <span +class='id identifier rubyid_expect'>expect</span> <span +class='lbrace'>{</span>

+ +
<span class='id identifier rubyid_folder'>folder</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_add_folder_member'>add_folder_member</span> <span class='id identifier rubyid_folder_id'>folder_id</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>somebody@test.com</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/InvalidIdError.html” title=“DropboxApi::Errors::InvalidIdError +(class)”>InvalidIdError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

39 40 41 42 43 44 45 46 47 48</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/add_folder_member.rb', line 39</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:add_folder_member</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_folder_id'>folder_id</span><span +class='comma'>,</span> <span class='id identifier +rubyid_members'>members</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='comma'>,</span> <span class='symbol'>:custom_message</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:custom_message</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>shared_folder_id:</span> <span class='id identifier rubyid_folder_id'>folder_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
+  <span class='label'>members:</span> <span class='id identifier rubyid_build_members_param'>build_members_param</span><span class='lparen'>(</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="copy-instance_method">
+
+  #<strong>copy</strong>(from, to)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Copy a file or folder to a different location in the user&#39;s Dropbox.
+ +

If the source path is a folder all its contents will be copied.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>from</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to be copied or moved.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>to</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox that is the destination.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'></span>
+
+    <div class='inline'><p>The moved file.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the copied file on success
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_spec.rb', line 15</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_copy'>copy</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/a.jpg</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/b.jpg</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>b.jpg</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the file can&#39;t be found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_spec.rb', line 15</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy'>copy</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/z.jpg</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/b.jpg</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the path is invalid
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

20 21 22</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_spec.rb', line 15</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy'>copy</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/../invalid_path.jpg</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/b.jpg</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/MalformedPathError.html” +title=“DropboxApi::Errors::MalformedPathError +(class)”>MalformedPathError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

15 16 17 18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy.rb', line 15</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:copy</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_from'>from</span><span +class='comma'>,</span> <span class='id identifier +rubyid_to'>to</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>from_path:</span> <span class='id identifier rubyid_from'>from</span><span class='comma'>,</span>
+  <span class='label'>to_path:</span> <span class='id identifier rubyid_to'>to</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="copy_batch-instance_method">
+
+  #<strong>copy_batch</strong>(entries, options = {})  &#x21d2; <tt>String</tt>, <tt>Array</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Copy multiple files or folders to different locations at once in the
+ +

user&#39;s Dropbox.</p>

+ +

<p>This will either finish synchronously, or return a job ID and do +the async copy job in background. Please use <span +class='object_link'><a +href=“#copy_batch_check-instance_method” +title=“DropboxApi::Client#copy_batch_check +(method)”>#copy_batch_check</a></span> to check the job +status.</p>

+ +

<p>Note: No errors are returned by this endpoint.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>entries</span>
+
+    <span class='type'>(<tt>Array&lt;Hash&gt;</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>List of entries to be moved or copied.
+ +

Each entry must be a hash with two keys: :from_path &amp; +:to_path.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">autorename</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If there&#39;s a conflict with any file,
+ +

have the Dropbox server try to autorename that file to avoid the conflict. +The default for this field is false.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Either the job id or the list of job statuses.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns an async job id
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

8 9 10 11 12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_job_id'>job_id</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_copy_batch'>copy_batch</span> <span +class='lbracket'>[</span><span +class='lbrace'>{</span>

+ +
<span class='label'>from_path:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+<span class='label'>to_path:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_renamed.txt</span><span class='tstring_end'>&quot;</span></span>
+ +

<span class='rbrace'>}</span><span +class='rbracket'>]</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_job_id'>job_id</span><span +class='rparen'>)</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dbjid:AAA6b4uwc19nEau5k-OBI_h-hjrR7pNDaUA3_0hOwV-UZ2pkw_zXWp3FSuVZrQ0d9IXKGkwB5JdYI4mJZumLc6qZ</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></pre>
+          </td>
+        </tr>
+      </table>
+    </li>
+
+    <li>
+      if autorename option is true, returns an async job id
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

18 19 20 21 22 23 24</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_job_id'>job_id</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_copy_batch'>copy_batch</span><span +class='lparen'>(</span><span +class='lbracket'>[</span><span +class='lbrace'>{</span>

+ +
<span class='label'>from_path:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_2.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+<span class='label'>to_path:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_2_renamed.txt</span><span class='tstring_end'>&quot;</span></span>
+ +

<span class='rbrace'>}</span><span +class='rbracket'>]</span><span +class='comma'>,</span> <span +class='label'>autorename:</span> <span +class='kw'>true</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_job_id'>job_id</span><span +class='rparen'>)</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dbjid:AABe-bOUUq5nrybciMJxIxaGAD16nGCKByGyY3Z_2m6kshGW903XTikVT3_5V6JQQu20p3QxoCfws7_hT40deF6q</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></pre>
+          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

25 26 27 28 29 30 31 32 33 34</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_batch.rb', line 25</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:copy_batch</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_entries'>entries</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:autorename</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:autorename</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>entries:</span> <span class='id identifier rubyid_entries'>entries</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="copy_batch_check-instance_method">
+
+  #<strong>copy_batch_check</strong>(async_job_id)  &#x21d2; <tt>:in_progress</tt>, <tt>Array</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the status of an asynchronous job for <span class='object_link'><a href="#copy_batch-instance_method" title="DropboxApi::Client#copy_batch (method)">#copy_batch</a></span>. It
+ +

returns a list of results for each entry.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>async_job_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Id of the asynchronous job.
+ +

This is the value of a response returned from the method that launched the +job.</p> </div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>:in_progress</tt>, <tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>This could be either the <code>:in_progress</code>
+ +

flag or a list of job statuses.</p> </div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns all types of entries
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10 11</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_check_spec.rb', line 17</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_copy_batch_check'>copy_batch_check</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsU</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_include'>include</span><span +class='lparen'>(</span><span class='id identifier +rubyid_a_kind_of'>a_kind_of</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder +(class)”>Folder</a></span></span><span +class='rparen'>)</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_include'>include</span><span +class='lparen'>(</span><span class='id identifier +rubyid_a_kind_of'>a_kind_of</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_include'>include</span><span +class='lparen'>(</span><span class='id identifier +rubyid_a_kind_of'>a_kind_of</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns &#39;invalid_async_job_id&#39; error
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_check_spec.rb', line 17</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_batch_check'>copy_batch_check</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsE</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/InvalidIdError.html” title=“DropboxApi::Errors::InvalidIdError +(class)”>InvalidIdError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_batch_check.rb', line 17</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:copy_batch_check</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_async_job_id'>async_job_id</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>async_job_id:</span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="copy_reference_get-instance_method">
+
+  #<strong>copy_reference_get</strong>(path)  &#x21d2; <tt><span class='object_link'><a href="Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">DropboxApi::Results::GetCopyReferenceResult</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get a copy reference to a file or folder.
+ +

This reference string can be used to save that file or folder to another +user&#39;s Dropbox by passing it to <span +class='object_link'><a +href=“#copy_reference_save-instance_method” +title=“DropboxApi::Client#copy_reference_save +(method)”>#copy_reference_save</a></span>.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to the file or folder you want to get a
+ +

copy reference to.</p> </div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt><span class='object_link'><a href="Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">DropboxApi::Results::GetCopyReferenceResult</a></span></tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns a copy reference
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

8 9 10 11 12 13</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_get_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_copy_reference_get'>copy_reference_get</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/GetCopyReferenceResult.html” +title=“DropboxApi::Results::GetCopyReferenceResult +(class)”>GetCopyReferenceResult</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_resource'>resource</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_copy_reference'>copy_reference</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'>String</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_expires'>expires</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'>Time</span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns a copy reference
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

19 20 21 22 23 24</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_get_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_copy_reference_get'>copy_reference_get</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/folder</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/GetCopyReferenceResult.html” +title=“DropboxApi::Results::GetCopyReferenceResult +(class)”>GetCopyReferenceResult</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_resource'>resource</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>folder</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_copy_reference'>copy_reference</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'>String</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_expires'>expires</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'>Time</span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

30 31 32</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_get_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_reference_get'>copy_reference_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/c.jpg</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_reference_get.rb', line 16</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:copy_reference_get</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="copy_reference_save-instance_method">
+
+  #<strong>copy_reference_save</strong>(copy_reference, path)  &#x21d2; <tt><span class='object_link'><a href="Results/SaveCopyReferenceResult.html" title="DropboxApi::Results::SaveCopyReferenceResult (class)">DropboxApi::Results::SaveCopyReferenceResult</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Save a copy reference returned by <span class='object_link'><a href="#copy_reference_get-instance_method" title="DropboxApi::Client#copy_reference_get (method)">#copy_reference_get</a></span> to the
+ +

user&#39;s Dropbox.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>copy_reference</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>A copy reference returned by
+ +

<span class='object_link'><a +href=“#copy_reference_get-instance_method” +title=“DropboxApi::Client#copy_reference_get +(method)”>#copy_reference_get</a></span>.</p> +</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox that is the destination.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt><span class='object_link'><a href="Results/SaveCopyReferenceResult.html" title="DropboxApi::Results::SaveCopyReferenceResult (class)">DropboxApi::Results::SaveCopyReferenceResult</a></span></tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the saved file
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

10 11 12 13</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_copy_reference_save'>copy_reference_save</span> +<span class='ivar'>@copy_reference</span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/copied-file.txt</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/SaveCopyReferenceResult.html” +title=“DropboxApi::Results::SaveCopyReferenceResult +(class)”>SaveCopyReferenceResult</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_resource'>resource</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>copied-file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns the saved folder
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

19 20 21 22 23</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+ +

<span class='id identifier +rubyid_copy_reference'>copy_reference</span> <span +class='op'>=</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>WI-v42h5NWxnbDZ2enpjbw</span><span +class='tstring_end'>&#39;</span></span> <span +class='id identifier rubyid_result'>result</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_copy_reference_save'>copy_reference_save</span> +<span class='id identifier +rubyid_copy_reference'>copy_reference</span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/copied-folder</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/SaveCopyReferenceResult.html” +title=“DropboxApi::Results::SaveCopyReferenceResult +(class)”>SaveCopyReferenceResult</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_resource'>resource</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>copied-folder</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

30 31 32</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_reference_save'>copy_reference_save</span> <span class='ivar'>@copy_reference</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/copied-file.txt</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/FileConflictError.html” +title=“DropboxApi::Errors::FileConflictError +(class)”>FileConflictError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

38 39 40</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_reference_save'>copy_reference_save</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid-reference</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/copied-file.txt</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/InvalidCopyReferenceError.html” +title=“DropboxApi::Errors::InvalidCopyReferenceError +(class)”>InvalidCopyReferenceError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

46 47 48</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_reference_save'>copy_reference_save</span> <span class='ivar'>@copy_reference</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>//copied-file.txt</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/MalformedPathError.html” +title=“DropboxApi::Errors::MalformedPathError +(class)”>MalformedPathError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

54 55 56</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_reference_save'>copy_reference_save</span> <span class='ivar'>@copy_reference</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/copied-file.txt</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NoPermissionError.html” +title=“DropboxApi::Errors::NoPermissionError +(class)”>NoPermissionError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

62 63 64</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_reference_save'>copy_reference_save</span> <span class='ivar'>@copy_reference</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/copied-file.txt</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18 19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_reference_save.rb', line 16</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:copy_reference_save</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_copy_reference'>copy_reference</span><span +class='comma'>,</span> <span class='id identifier +rubyid_path'>path</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>copy_reference:</span> <span class='id identifier rubyid_copy_reference'>copy_reference</span><span class='comma'>,</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="create_file_request-instance_method">
+
+  #<strong>create_file_request</strong>(title, destination)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Create a file request for a given path.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>title</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The title of the file request. Must not be empty.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>destination</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path of the folder in the Dropbox where
+ +

uploaded files will be sent. For apps with the app folder permission, this +will be relative to the app folder.</p> </div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the new file request on success
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

8 9 10 11</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/file_requests/create_file_request_spec.rb', line 15</span>
+ +

<span class='id identifier +rubyid_file_request'>file_request</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_create_file_request'>create_file_request</span> +<span class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Arizona, baby</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/arizona_baby</span><span +class='tstring_end'>&quot;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file_request'>file_request</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/FileRequest.html” title=“DropboxApi::Metadata::FileRequest +(class)”>FileRequest</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file_request'>file_request</span><span +class='period'>.</span><span class='id identifier +rubyid_title'>title</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Arizona, baby</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises something if wrong path
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/file_requests/create_file_request_spec.rb', line 15</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_file_request'>create_file_request</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Arizona, baby</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file.txt</span><span class='tstring_end'>&quot;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/CreateFileRequestError.html” +title=“DropboxApi::Errors::CreateFileRequestError +(class)”>CreateFileRequestError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

15 16 17 18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/file_requests/create_file_request.rb', line 15</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:create_file_request</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_title'>title</span><span +class='comma'>,</span> <span class='id identifier +rubyid_destination'>destination</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>title:</span> <span class='id identifier rubyid_title'>title</span><span class='comma'>,</span>
+  <span class='label'>destination:</span> <span class='id identifier rubyid_destination'>destination</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="create_folder-instance_method">
+
+  #<strong>create_folder</strong>(path)  &#x21d2; <tt><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">DropboxApi::Metadata::Folder</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Create a folder at a given path.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to create.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">DropboxApi::Metadata::Folder</a></span></tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The new folder.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the new folder on success
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_spec.rb', line 13</span>
+ +

<span class='id identifier rubyid_folder'>folder</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_create_folder'>create_folder</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/arizona_baby</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_folder'>folder</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder +(class)”>Folder</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_folder'>folder</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>arizona_baby</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the name is invalid
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_spec.rb', line 13</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder'>create_folder</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/arizona\\baby</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/MalformedPathError.html” +title=“DropboxApi::Errors::MalformedPathError +(class)”>MalformedPathError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the resource causes a conflict
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

20 21 22</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_spec.rb', line 13</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder'>create_folder</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/b.jpg</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/FileConflictError.html” +title=“DropboxApi::Errors::FileConflictError +(class)”>FileConflictError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

13 14 15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder.rb', line 13</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:create_folder</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="create_folder_batch-instance_method">
+
+  #<strong>create_folder_batch</strong>(paths, options = {})  &#x21d2; <tt>String</tt>, <tt>Array</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Create multiple folders at once.</p>
+ +

<p>This route is asynchronous for large batches, which returns a job +ID immediately and runs the create folder batch asynchronously. Otherwise, +creates the folders and returns the result synchronously for smaller +inputs. You can force asynchronous behaviour by using the +:force_async flag. Use <span +class='object_link'><a +href=“#create_folder_batch_check-instance_method” +title=“DropboxApi::Client#create_folder_batch_check +(method)”>#create_folder_batch_check</a></span> to check the +job status.</p>

+ +

<p>Note: No errors are returned by this endpoint.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>paths</span>
+
+    <span class='type'>(<tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>List of paths to be created in the user&#39;s Dropbox.
+ +

Duplicate path arguments in the batch are considered only once.</p> +</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">autorename</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If there&#39;s a conflict, have the
+ +

Dropbox server try to autorename the folder to avoid the conflict. The +default for this field is false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">force_async</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Whether to force the create to
+ +

happen asynchronously. The default for this field is +false.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Either the job id or the list of job statuses.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the created folders synchronously
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_create_folder_batch'>create_folder_batch</span> +<span class='lbracket'>[</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/Create Batch</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/Create Batch 1</span><span +class='tstring_end'>&#39;</span></span><span +class='rbracket'>]</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_first'>first</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder +(class)”>Folder</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_last'>last</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder +(class)”>Folder</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns async_job_id when large entries are passed
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16 17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28</span>
+ +

<span class='id identifier rubyid_paths'>paths</span> +<span class='op'>=</span> <span +class='lbracket'>[</span><span +class='rbracket'>]</span> <span +class='int'>100</span><span +class='period'>.</span><span class='id identifier +rubyid_times'>times</span> <span +class='lbrace'>{</span> <span +class='op'>|</span><span class='id identifier +rubyid_i'>i</span><span +class='op'>|</span> <span class='id identifier +rubyid_paths'>paths</span> <span +class='op'>&lt;&lt;</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/Folder </span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_i'>i</span><span +class='embexpr_end'>}</span><span +class='tstring_end'>&quot;</span></span><span +class='rbrace'>}</span>

+ +

<span class='id identifier +rubyid_async_result'>async_result</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_create_folder_batch'>create_folder_batch</span><span +class='lparen'>(</span><span class='id identifier +rubyid_paths'>paths</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'>Hash</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_have_key'>have_key</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>async_job_id</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns async_job_id when force_async is true
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

23 24 25 26</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28</span>
+ +

<span class='id identifier +rubyid_async_result'>async_result</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_create_folder_batch'>create_folder_batch</span><span +class='lparen'>(</span><span +class='lbracket'>[</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/Create Batch 2</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/Create Batch 3</span><span +class='tstring_end'>&#39;</span></span><span +class='rbracket'>]</span><span +class='comma'>,</span> <span +class='lbrace'>{</span> <span +class='label'>force_async:</span> <span +class='kw'>true</span> <span +class='rbrace'>}</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'>Hash</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_have_key'>have_key</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>async_job_id</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  when autorename is true, does not return error for repeated entries
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

30 31 32</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_create_folder_batch'>create_folder_batch</span><span +class='lparen'>(</span><span +class='lbracket'>[</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/Create Batch 1</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/Create Batch 1</span><span +class='tstring_end'>&#39;</span></span><span +class='rbracket'>]</span><span +class='comma'>,</span> <span +class='lbrace'>{</span> <span +class='label'>autorename:</span> <span +class='kw'>true</span> <span +class='rbrace'>}</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_not_to'>not_to</span> <span class='id identifier +rubyid_include'>include</span><span +class='lparen'>(</span><span class='id identifier +rubyid_a_kind_of'>a_kind_of</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/FolderConflictError.html” +title=“DropboxApi::Errors::FolderConflictError +(class)”>FolderConflictError</a></span></span><span +class='rparen'>)</span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises error, when invalid option is passed
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

36 37 38</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch'>create_folder_batch</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/Create Batch 4</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/Create Batch 5</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>async:</span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'>ArgumentError</span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

28 29 30 31 32 33 34 35 36 37 38 39</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder_batch.rb', line 28</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:create_folder_batch</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_paths'>paths</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:autorename</span><span class='comma'>,</span>
+  <span class='symbol'>:force_async</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:autorename</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:force_async</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>paths:</span> <span class='id identifier rubyid_paths'>paths</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="create_folder_batch_check-instance_method">
+
+  #<strong>create_folder_batch_check</strong>(async_job_id)  &#x21d2; <tt>Array</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the status of an asynchronous job for create_folder_batch.
+ +

If success, it returns list of result for each entry.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>async_job_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Id of the asynchronous job.
+ +

This is the value of a response returned from the method that launched the +job.</p> </div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>A list of one result for each entry.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns mixed results with failure and success status for each entry
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10 11</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_check_spec.rb', line 16</span>
+ +

<span class='id identifier +rubyid_async_result'>async_result</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_create_folder_batch_check'>create_folder_batch_check</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQE</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_include'>include</span><span +class='lparen'>(</span><span class='id identifier +rubyid_a_kind_of'>a_kind_of</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder +(class)”>Folder</a></span></span><span +class='rparen'>)</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_include'>include</span><span +class='lparen'>(</span><span class='id identifier +rubyid_a_kind_of'>a_kind_of</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/MalformedPathError.html” +title=“DropboxApi::Errors::MalformedPathError +(class)”>MalformedPathError</a></span></span><span +class='rparen'>)</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_include'>include</span><span +class='lparen'>(</span><span class='id identifier +rubyid_a_kind_of'>a_kind_of</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/FolderConflictError.html” +title=“DropboxApi::Errors::FolderConflictError +(class)”>FolderConflictError</a></span></span><span +class='rparen'>)</span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error with an invalid async job id
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_check_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch_check'>create_folder_batch_check</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/InvalidIdError.html” title=“DropboxApi::Errors::InvalidIdError +(class)”>InvalidIdError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder_batch_check.rb', line 16</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:create_folder_batch_check</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_async_job_id'>async_job_id</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>async_job_id:</span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="create_shared_link_with_settings-instance_method">
+
+  #<strong>create_shared_link_with_settings</strong>(path, settings = {})  &#x21d2; <tt><span class='object_link'><a href="Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">DropboxApi::Metadata::SharedLinkMetadata</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Create a shared link with custom settings. If no settings are given then
+ +

the default visibility is :public. (The resolved visibility, though, may +depend on other aspects such as team and shared folder settings).</p>

+ +

<p>NOTE: The settings parameter will only work for pro, +business or enterprise accounts. It will return no permission error +otherwise.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to be shared by the shared link.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>settings</span>
+
+    <span class='type'>(<tt>SharedLinkSettings</tt>)</span>
+
+    <em class="default">(defaults to: <tt>{}</tt>)</em>
+
+    &mdash;
+    <div class='inline'><p>The requested settings for the newly
+ +

created shared link This field is optional.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>settings</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">requested_visibility</span>
+      <span class="type">(<tt>Object</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The requested access for this
+ +

shared link. This field is optional. Must be one of +&quot;public&quot;, &quot;team_only&quot; or +&quot;password&quot;.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">link_password</span>
+  <span class="type">(<tt>Object</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If requested_visibility is
+ +

&quot;password&quot; this is needed to specify the password to +access the link. This field is optional.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">expires</span>
+  <span class="type">(<tt>Object</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Expiration time of the shared link. By default
+ +

the link won&#39;t expire. This field is optional.</p> +</div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt><span class='object_link'><a href="Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">DropboxApi::Metadata::SharedLinkMetadata</a></span></tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      creates a shared link for basic and pro users
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+ +

<span class='id identifier rubyid_link'>link</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span> +<span class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/file_for_sharing.docx</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_link'>link</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/FileLinkMetadata.html” +title=“DropboxApi::Metadata::FileLinkMetadata +(class)”>FileLinkMetadata</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  creates a shared link with settings for pro users
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+ +

<span class='id identifier rubyid_link'>link</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/file_for_sharing.docx</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='lbrace'>{</span> <span +class='label'>expires:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>2019-03-12T10:34:42Z</span><span +class='tstring_end'>&#39;</span></span> <span +class='rbrace'>}</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_link'>link</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/FileLinkMetadata.html” +title=“DropboxApi::Metadata::FileLinkMetadata +(class)”>FileLinkMetadata</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if settings options are passed for basic users
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

20 21 22</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/file_for_sharing.docx</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>expires:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>2019-03-12T10:34:42Z</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NoPermissionError.html” +title=“DropboxApi::Errors::NoPermissionError +(class)”>NoPermissionError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if already shared for basic and pro users
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

26 27 28</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/file_for_sharing.docx</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/SharedLinkAlreadyExistsError.html” +title=“DropboxApi::Errors::SharedLinkAlreadyExistsError +(class)”>SharedLinkAlreadyExistsError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  creates a shared link for basic and pro users
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

34 35 36</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+ +

<span class='id identifier rubyid_link'>link</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span> +<span class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/folder_for_sharing</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_link'>link</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/FolderLinkMetadata.html” +title=“DropboxApi::Metadata::FolderLinkMetadata +(class)”>FolderLinkMetadata</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  creates a shared link with settings for pro users
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

40 41 42</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+ +

<span class='id identifier rubyid_link'>link</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/folder_for_sharing</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='lbrace'>{</span> <span +class='label'>expires:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>2019-03-12T10:34:42Z</span><span +class='tstring_end'>&#39;</span></span> <span +class='rbrace'>}</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_link'>link</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/FolderLinkMetadata.html” +title=“DropboxApi::Metadata::FolderLinkMetadata +(class)”>FolderLinkMetadata</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if settings options are passed for basic user
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

46 47 48</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/folder_for_sharing</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>expires:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>2019-03-12T10:34:42Z</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NoPermissionError.html” +title=“DropboxApi::Errors::NoPermissionError +(class)”>NoPermissionError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb', line 32</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:create_shared_link_with_settings</span> +<span class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_settings'>settings</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:requested_visibility</span><span class='comma'>,</span>
+  <span class='symbol'>:link_password</span><span class='comma'>,</span>
+  <span class='symbol'>:expires</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:requested_visibility</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>public</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:link_password</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+<span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:expires</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
+  <span class='label'>settings:</span> <span class='id identifier rubyid_settings'>settings</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="delete-instance_method">
+
+  #<strong>delete</strong>(path, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Delete the file or folder at a given path.</p>
+ +

<p>If the path is a folder, all its contents will be deleted +too.</p>

+ +

<p>A successful response indicates that the file or folder was +deleted. The returned metadata will be the corresponding <span +class='object_link'><a href=“Metadata/File.html” +title=“DropboxApi::Metadata::File +(class)”>Metadata::File</a></span> or <span +class='object_link'><a href=“Metadata/Folder.html” +title=“DropboxApi::Metadata::Folder +(class)”>Metadata::Folder</a></span> for the item at time of +deletion, and not a <span class='object_link'><a +href=“Metadata/Deleted.html” title=“DropboxApi::Metadata::Deleted +(class)”>Metadata::Deleted</a></span> object.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to delete.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">parent_rev</span>
+      <span class="type">(<tt>String</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Perform delete if given &quot;rev&quot;
+ +

matches the existing file&#39;s latest &quot;rev&quot;. This +field does not support deleting a folder. If the given +&quot;rev&quot; doesn&#39;t match, a <span +class='object_link'><a href=“Errors/FileConflictError.html” +title=“DropboxApi::Errors::FileConflictError +(class)”>Errors::FileConflictError</a></span> will be +raised.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the deleted file
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

8 9 10 11</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_delete'>delete</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/will_be_deleted.txt</span><span +class='tstring_end'>&quot;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>will_be_deleted.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  won&#39;t delete the file if `parent_rev` doesn&#39;t match
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/wont_be_deleted.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>parent_rev:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1c0576c68d6</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/FileConflictError.html” +title=“DropboxApi::Errors::FileConflictError +(class)”>FileConflictError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns the deleted folder
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

21 22 23 24</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_folder'>folder</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_delete'>delete</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/folder</span><span +class='tstring_end'>&quot;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_folder'>folder</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder +(class)”>Folder</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_folder'>folder</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>folder</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the name is invalid
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/unexisting folder</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

25 26 27 28 29 30 31</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete.rb', line 25</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:delete</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:parent_rev</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="delete_batch-instance_method">
+
+  #<strong>delete_batch</strong>(entries)  &#x21d2; <tt>String</tt>, <tt>Array</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Delete multiple files/folders at once.</p>
+ +

<p>This route is asynchronous, which returns a job ID immediately and +runs the delete batch asynchronously. Use <span +class='object_link'><a +href=“#delete_batch_check-instance_method” +title=“DropboxApi::Client#delete_batch_check +(method)”>#delete_batch_check</a></span> to check the job +status.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>entries</span>
+
+    <span class='type'>(<tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>List of entries, each entry is a Hash with these
+ +

fields: path (mandatory) &amp; parent_rev +(optional).</p> </div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Either the job id or the list of job statuses.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns async_job_id for multiple entries
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

9 10 11 12 13</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_spec.rb', line 17</span>
+ +

<span class='id identifier +rubyid_entries'>entries</span> <span +class='op'>=</span> <span +class='lbracket'>[</span><span +class='lbrace'>{</span> <span +class='label'>path:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/folder_to_delete_1</span><span +class='tstring_end'>&#39;</span></span> <span +class='rbrace'>}</span><span +class='comma'>,</span> <span +class='lbrace'>{</span> <span +class='label'>path:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/folder_to_delete_2</span><span +class='tstring_end'>&#39;</span></span> <span +class='rbrace'>}</span><span +class='rbracket'>]</span> <span class='id +identifier rubyid_async_result'>async_result</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_delete_batch'>delete_batch</span> <span +class='id identifier rubyid_entries'>entries</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'>Hash</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_have_key'>have_key</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>async_job_id</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns async_job_id for single entry too
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

17 18 19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_spec.rb', line 17</span>
+ +

<span class='id identifier +rubyid_entries'>entries</span> <span +class='op'>=</span> <span +class='lbracket'>[</span><span +class='lbrace'>{</span> <span +class='label'>path:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/folder_to_delete/file_to_delete.docx</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='label'>parent_rev:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>1c0576c68d6</span><span +class='tstring_end'>&#39;</span></span> <span +class='rbrace'>}</span><span +class='rbracket'>]</span> <span class='id +identifier rubyid_async_result'>async_result</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_delete_batch'>delete_batch</span> <span +class='id identifier rubyid_entries'>entries</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'>Hash</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_have_key'>have_key</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>async_job_id</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

17 18 19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete_batch.rb', line 17</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:delete_batch</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_entries'>entries</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>entries:</span> <span class='id identifier rubyid_entries'>entries</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="delete_batch_check-instance_method">
+
+  #<strong>delete_batch_check</strong>(async_job_id)  &#x21d2; <tt>:in_progress</tt>, <tt>Array</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the status of an asynchronous job for delete_batch. If success,
+ +

it returns list of result for each entry.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>async_job_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Id of the asynchronous job.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>:in_progress</tt>, <tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>This could be either the <code>:in_progress</code>
+ +

flag or a list of job statuses.</p> </div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns mixed results when complete
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10 11 12</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_check_spec.rb', line 15</span>
+ +

<span class='id identifier +rubyid_async_result'>async_result</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_delete_batch_check'>delete_batch_check</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>dbjid:AAC2JUPMEtK-kEg7QVrNEemnX-FfQkJ_0r_tJJ2UpHhwvrUGrpw19CH4U5cfZKWPLxLVJoKgffTOy_zSKk6W953h</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_include'>include</span><span +class='lparen'>(</span><span class='id identifier +rubyid_a_kind_of'>a_kind_of</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder +(class)”>Folder</a></span></span><span +class='rparen'>)</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_include'>include</span><span +class='lparen'>(</span><span class='id identifier +rubyid_a_kind_of'>a_kind_of</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_include'>include</span><span +class='lparen'>(</span><span class='id identifier +rubyid_a_kind_of'>a_kind_of</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/FileConflictError.html” +title=“DropboxApi::Errors::FileConflictError +(class)”>FileConflictError</a></span></span><span +class='rparen'>)</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_async_result'>async_result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_include'>include</span><span +class='lparen'>(</span><span class='id identifier +rubyid_a_kind_of'>a_kind_of</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error with an invalid async job id
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_check_spec.rb', line 15</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_batch_check'>delete_batch_check</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/InvalidIdError.html” title=“DropboxApi::Errors::InvalidIdError +(class)”>InvalidIdError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

15 16 17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete_batch_check.rb', line 15</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:delete_batch_check</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_async_job_id'>async_job_id</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>async_job_id:</span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="download-instance_method">
+
+  #<strong>download</strong>(path, &amp;block)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Download a file from a user&#39;s Dropbox.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path of the file to download.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the file
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/download_spec.rb', line 12</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_download'>download</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  yields the file contents
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16 17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/download_spec.rb', line 12</span>
+ +

<span class='id identifier +rubyid_file_contents'>file_contents</span> <span +class='op'>=</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_end'>&#39;</span></span> <span +class='id identifier rubyid_file'>file</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_download'>download</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&#39;</span></span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_chunk'>chunk</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_file_contents'>file_contents</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_file_contents'>file_contents</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_chunk'>chunk</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+ +

<span class='kw'>end</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file_contents'>file_contents</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>Hola Leo!n</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the name is invalid
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

23 24 25</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/download_spec.rb', line 12</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_download'>download</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/c.jpg</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/download.rb', line 12</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:download</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span +class='op'>&amp;</span><span class='id +identifier rubyid_block'>block</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="get_account-instance_method">
+
+  #<strong>get_account</strong>(account_id)  &#x21d2; <tt>BasicAccount</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get information about a user&#39;s account.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>account_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>A user&#39;s account identifier.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>BasicAccount</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Basic information about any account.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the account information
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_account_spec.rb', line 13</span>
+ +

<span class='id identifier +rubyid_account'>account</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_account'>get_account</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_account'>account</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/BasicAccount.html” title=“DropboxApi::Metadata::BasicAccount +(class)”>BasicAccount</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the account can&#39;t be found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_account_spec.rb', line 13</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_account'>get_account</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NoAccountError.html” title=“DropboxApi::Errors::NoAccountError +(class)”>NoAccountError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/users/get_account.rb', line 13</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_account</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_account_id'>account_id</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>account_id:</span> <span class='id identifier rubyid_account_id'>account_id</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="get_account_batch-instance_method">
+
+  #<strong>get_account_batch</strong>(account_ids)  &#x21d2; <tt>Array&lt;BasicAccount&gt;</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get information about multiple user accounts. At most 300 accounts may
+ +

be queried per request.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>account_ids</span>
+
+    <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>List of user account identifiers. Should not
+ +

contain any duplicate account IDs.</p> </div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>Array&lt;BasicAccount&gt;</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Basic information about any account.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns account information of all given IDs
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10 11 12 13 14 15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_account_batch_spec.rb', line 15</span>
+ +

<span class='id identifier +rubyid_test_accounts'>test_accounts</span> <span +class='op'>=</span> <span +class='lbrace'>{</span>

+ +
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dbid:AACiYqkuK0t_wIvlr9BduHKdhzk_H28Dg0U</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Antonio Hidalgo</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Jesus Burgos</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span> <span class='id +identifier rubyid_accounts'>accounts</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_account_batch'>get_account_batch</span> <span +class='id identifier +rubyid_test_accounts'>test_accounts</span><span +class='period'>.</span><span class='id identifier +rubyid_keys'>keys</span>

+ +

<span class='id identifier +rubyid_accounts'>accounts</span><span +class='period'>.</span><span class='id identifier +rubyid_each'>each</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_account'>account</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_account'>account</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/BasicAccount.html" title="DropboxApi::Metadata::BasicAccount (class)">BasicAccount</a></span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_account'>account</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_display_name'>display_name</span><span class='rparen'>)</span>
+  <span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='id identifier rubyid_test_accounts'>test_accounts</span><span class='lbracket'>[</span><span class='id identifier rubyid_account'>account</span><span class='period'>.</span><span class='id identifier rubyid_account_id'>account_id</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if one account cannot be found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

21 22 23 24 25 26 27 28</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_account_batch_spec.rb', line 15</span>
+ +

<span class='id identifier +rubyid_account_ids'>account_ids</span> <span +class='op'>=</span> <span +class='qwords_beg'>%w(</span><span +class='words_sep'>

+ +
</span><span class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX</span><span class='words_sep'>
+</span><span class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs</span><span class='words_sep'>
+ +

</span><span +class='tstring_end'>)</span></span>

+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_account_batch'>get_account_batch</span> <span class='id identifier rubyid_account_ids'>account_ids</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NoAccountError.html” title=“DropboxApi::Errors::NoAccountError +(class)”>NoAccountError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/users/get_account_batch.rb', line 15</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_account_batch</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_account_ids'>account_ids</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>account_ids:</span> <span class='id identifier rubyid_account_ids'>account_ids</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="get_current_account-instance_method">
+
+  #<strong>get_current_account</strong>  &#x21d2; <tt>BasicAccount</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get information about the current user&#39;s account.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>BasicAccount</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Detailed information about the current user&#39;s account.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the account usage information
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_space_usage_spec.rb', line 12</span>
+ +

<span class='id identifier +rubyid_space_usage'>space_usage</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_space_usage'>get_space_usage</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_space_usage'>space_usage</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/SpaceUsage.html” title=“DropboxApi::Metadata::SpaceUsage +(class)”>SpaceUsage</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns the current account information
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

7 8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/users/get_current_account_spec.rb', line 12</span>
+ +

<span class='id identifier +rubyid_account'>account</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_current_account'>get_current_account</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_account'>account</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/BasicAccount.html” title=“DropboxApi::Metadata::BasicAccount +(class)”>BasicAccount</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_account'>account</span><span +class='period'>.</span><span class='id identifier +rubyid_root_info'>root_info</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/UserRootInfo.html” title=“DropboxApi::Metadata::UserRootInfo +(class)”>UserRootInfo</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/users/get_current_account.rb', line 12</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_current_account</span> <span +class='kw'>do</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='kw'>nil</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="get_metadata-instance_method">
+
+  #<strong>get_metadata</strong>(path, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the metadata for a file or folder.</p>
+ +

<p>Note: Metadata for the root folder is unsupported.</p>

+ +

<p>If you request the media_info attribute, note that it +could be set to :pending or nil.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path of a file or folder on Dropbox.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">include_media_info</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If <code>true</code>, <code>media_info</code>
+ +

is set for photo and video. The default for this field is +false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">include_has_explicit_shared_members</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>,
+ +

the results will include a flag for each file indicating whether or not +that file has any explicit members. The default for this field is +false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">include_deleted</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>,
+ +

<span class='object_link'><a href=“Metadata/Deleted.html” +title=“DropboxApi::Metadata::Deleted +(class)”>Metadata::Deleted</a></span> will be returned for +deleted file or folder, otherwise <span +class='object_link'><a href=“Errors/NotFoundError.html” +title=“DropboxApi::Errors::NotFoundError +(class)”>Errors::NotFoundError</a></span> will be raised. +The default for this field is false.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      may return a `File`
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

8 9 10 11</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_metadata'>get_metadata</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  will parse time specific fields
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_metadata'>get_metadata</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_client_modified'>client_modified</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='const'>Time</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='lparen'>(</span><span +class='int'>1988</span><span +class='comma'>,</span> <span +class='int'>12</span><span +class='comma'>,</span> <span +class='int'>8</span><span +class='comma'>,</span> <span +class='int'>1</span><span +class='comma'>,</span> <span +class='int'>1</span><span +class='comma'>,</span> <span +class='int'>0</span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>+00:00</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  may return a `Folder`
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

21 22 23 24</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+ +

<span class='id identifier rubyid_folder'>folder</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_metadata'>get_metadata</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/folder</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_folder'>folder</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder +(class)”>Folder</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_folder'>folder</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>folder</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the path is wrong
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_metadata'>get_metadata</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/unexisting_folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if an invalid option is given
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

34 35 36</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_metadata'>get_metadata</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/file.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>invalid_option:</span> <span class='kw'>true</span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span> <span +class='const'>ArgumentError</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

41 42 43</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_metadata'>get_metadata</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/deleted_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  with `:include_deleted`, returns a `File`
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

47 48 49 50</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_metadata_spec.rb', line 30</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_metadata'>get_metadata</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/deleted_file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='label'>include_deleted:</span> <span +class='kw'>true</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/Deleted.html” title=“DropboxApi::Metadata::Deleted +(class)”>Deleted</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>deleted_file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

30 31 32 33 34 35 36 37 38 39 40</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_metadata.rb', line 30</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_metadata</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:include_media_info</span><span class='comma'>,</span>
+  <span class='symbol'>:include_deleted</span><span class='comma'>,</span>
+  <span class='symbol'>:include_has_explicit_shared_members</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="get_preview-instance_method">
+
+  #<strong>get_preview</strong>(path, &amp;block)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get a preview for a file. Currently previews are only generated for the
+ +

files with the following extensions: .doc, .docx, .docm, .ppt, .pps, .ppsx, +.ppsm, .pptx, .pptm, .xls, .xlsx, .xlsm, .rtf</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path of the file to preview.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the file
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_preview_spec.rb', line 14</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_preview'>get_preview</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/file.docx</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file.docx</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the name is invalid
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_preview_spec.rb', line 14</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_preview'>get_preview</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/unknown_file.jpg</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_preview.rb', line 14</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_preview</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span +class='op'>&amp;</span><span class='id +identifier rubyid_block'>block</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="get_shared_link_metadata-instance_method">
+
+  #<strong>get_shared_link_metadata</strong>(preview_link, options = {})  &#x21d2; <tt>SharedFileMembers</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get the Metadata for a shared link</p>
+ +

<p>If a preview url is given, returns the shared file or folder that +is represent by that link.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">path</span>
+      <span class="type">(<tt>String</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If the shared link is to a folder,
+ +

this parameter can be used to retrieve the metadata for a specific file or +sub-folder in this folder. A relative path should be used.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">link_password</span>
+  <span class="type">(<tt>String</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If the shared link has
+ +

a password, this parameter can be used.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>SharedFileMembers</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      works with a file
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

11 12 13 14 15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 23</span>
+ +

<span class='id identifier +rubyid_shared_link'>shared_link</span> <span +class='op'>=</span> <span +class='ivar'>@client</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<span class='period'>.</span><span class='id identifier rubyid_links'>links</span>
+<span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_shared_link_metadata'>get_shared_link_metadata</span> +<span class='id identifier +rubyid_shared_link'>shared_link</span><span +class='period'>.</span><span class='id identifier +rubyid_url'>url</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/FileLinkMetadata.html” +title=“DropboxApi::Metadata::FileLinkMetadata +(class)”>FileLinkMetadata</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  works with a folder
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

21 22 23 24 25 26 27</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 23</span>
+ +

<span class='id identifier +rubyid_shared_link'>shared_link</span> <span +class='op'>=</span> <span +class='ivar'>@client</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<span class='period'>.</span><span class='id identifier rubyid_links'>links</span>
+<span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_shared_link_metadata'>get_shared_link_metadata</span> +<span class='id identifier +rubyid_shared_link'>shared_link</span><span +class='period'>.</span><span class='id identifier +rubyid_url'>url</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/FolderLinkMetadata.html” +title=“DropboxApi::Metadata::FolderLinkMetadata +(class)”>FolderLinkMetadata</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the link can&#39;t be found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

31 32 33 34 35</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 23</span>
+ +

<span class='id identifier +rubyid_bad_link'>bad_link</span> <span +class='op'>=</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>www.dropbox.com/sh/abcd/1234?dl=0 +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_shared_link_metadata'>get_shared_link_metadata</span> <span class='id identifier rubyid_bad_link'>bad_link</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/SharedLinkNotFoundError.html” +title=“DropboxApi::Errors::SharedLinkNotFoundError +(class)”>SharedLinkNotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

23 24 25 26 27 28 29</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb', line 23</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_shared_link_metadata</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_preview_link'>preview_link</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:link_password</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span>
+  <span class='label'>url:</span> <span class='id identifier rubyid_preview_link'>preview_link</span>
+<span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="get_space_usage-instance_method">
+
+  #<strong>get_space_usage</strong>  &#x21d2; <tt>SpaceUsage</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get the space usage information for the current user&#39;s account.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>SpaceUsage</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Information about a user&#39;s space usage and quota.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/users/get_space_usage.rb', line 12</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_space_usage</span> <span +class='kw'>do</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='kw'>nil</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="get_temporary_link-instance_method">
+
+  #<strong>get_temporary_link</strong>(path)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get a temporary link to stream content of a file. This link will expire
+ +

in four hours and afterwards you will get 410 Gone. Content-Type of the +link is determined automatically by the file&#39;s mime type.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to the file you want a temporary link to.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns a GetTemporaryLinkResult with file and link
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_temporary_link_spec.rb', line 14</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_temporary_link'>get_temporary_link</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/img.png</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/GetTemporaryLinkResult.html” +title=“DropboxApi::Results::GetTemporaryLinkResult +(class)”>GetTemporaryLinkResult</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>img.png</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the file can&#39;t be found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_temporary_link_spec.rb', line 14</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_preview'>get_preview</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/unknown_file.jpg</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_temporary_link.rb', line 14</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_temporary_link</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="get_thumbnail-instance_method">
+
+  #<strong>get_thumbnail</strong>(path, options = {}, &amp;block)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get a thumbnail for an image.</p>
+ +

<p>This method currently supports files with the following file +extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger +than 20MB in size won&#39;t be converted to a thumbnail.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+    <pre class="example code"><code><span class='comment'># Save thumbnail to a local file
+ +

</span><span class='id identifier +rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“#initialize-instance_method” title=“DropboxApi::Client#initialize +(method)”>new</a></span></span> <span class='id +identifier rubyid_file'>file</span> <span +class='op'>=</span> <span +class='const'>File</span><span +class='period'>.</span><span class='id identifier +rubyid_open'>open</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>thumbnail.png</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>w</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_thumbnail'>get_thumbnail</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/dropbox_image.png</span><span +class='tstring_end'>&quot;</span></span> +<span class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_thumbnail_content'>thumbnail_content</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_thumbnail_content'>thumbnail_content</span>
+ +

<span class='kw'>end</span> <span class='id +identifier rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_close'>close</span></code></pre>

+ +
<pre class="example code"><code><span class='comment'># Save thumbnail to a local file with .jpg format
+ +

</span><span class='id identifier +rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“#initialize-instance_method” title=“DropboxApi::Client#initialize +(method)”>new</a></span></span> <span class='id +identifier rubyid_file'>file</span> <span +class='op'>=</span> <span +class='const'>File</span><span +class='period'>.</span><span class='id identifier +rubyid_open'>open</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>thumbnail.jpg</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>w</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_thumbnail'>get_thumbnail</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/dropbox_image.png</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='symbol'>:format</span> <span +class='op'>=&gt;</span> <span +class='symbol'>:jpeg</span><span +class='rparen'>)</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_thumbnail_content'>thumbnail_content</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_thumbnail_content'>thumbnail_content</span>
+ +

<span class='kw'>end</span> <span class='id +identifier rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_close'>close</span></code></pre>

+ +
<pre class="example code"><code><span class='comment'># Upload thumbnail to Amazon S3 (assuming you&#39;re using their SDK)
+ +

</span><span class='id identifier +rubyid_s3_object'>s3_object</span> <span +class='op'>=</span> <span +class='const'>AWS</span><span +class='op'>::</span><span +class='const'>S3</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='period'>.</span><span class='id identifier +rubyid_s3'>s3</span><span +class='period'>.</span><span class='id identifier +rubyid_buckets'>buckets</span><span +class='lbracket'>[</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>my-bucket</span><span +class='tstring_end'>&#39;</span></span><span +class='rbracket'>]</span><span +class='period'>.</span><span class='id identifier +rubyid_objects'>objects</span><span +class='lbracket'>[</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>key</span><span +class='tstring_end'>&#39;</span></span><span +class='rbracket'>]</span> <span +class='comment'>#=&gt; &lt;AWS::S3::S3Object …&gt; +</span><span class='id identifier +rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“#initialize-instance_method” title=“DropboxApi::Client#initialize +(method)”>new</a></span></span> <span class='id +identifier rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_thumbnail'>get_thumbnail</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/dropbox_image.png</span><span +class='tstring_end'>&quot;</span></span> +<span class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_thumbnail_content'>thumbnail_content</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_s3_object'>s3_object</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_thumbnail_content'>thumbnail_content</span>
+ +

<span class='kw'>end</span></code></pre>

+ +
</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to the image file you want to thumbnail.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">format</span>
+      <span class="type">(<tt>:jpeg</tt>, <tt>:png</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The format for the thumbnail image,
+ +

:jpeg (default) or :png. For images that are +photos, :jpeg should be preferred, while png is better for +screenshots and digital arts. The default is :jpeg.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">size</span>
+  <span class="type">(<tt>:w32h32</tt>, <tt>:w64h64</tt>, <tt>:w128h128</tt>, <tt>:w640h480</tt>, <tt>:w1024h768</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>The size for the thumbnail image. The default is <code>:w64h64</code>.</p>
+ +

</div>

+ +
    </li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns a file
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_thumbnail_spec.rb', line 48</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_thumbnail'>get_thumbnail</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/img.png</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>img.png</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the file can&#39;t be found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_thumbnail_spec.rb', line 48</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_thumbnail'>get_thumbnail</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/unknown_file.jpg</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an argument error with invalid options
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

20 21 22</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_thumbnail_spec.rb', line 48</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_thumbnail'>get_thumbnail</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/img.png</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>invalid_arg:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>value</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'>ArgumentError</span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

48 49 50 51 52 53 54 55 56</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_thumbnail.rb', line 48</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_thumbnail</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='comma'>,</span> <span +class='op'>&amp;</span><span class='id +identifier rubyid_block'>block</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='comma'>,</span> <span class='symbol'>:size</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:jpeg</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:size</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:w64h64</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="get_thumbnail_batch-instance_method">
+
+  #<strong>get_thumbnail_batch</strong>(paths, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get a thumbnails for a batch of images.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>paths</span>
+
+    <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The paths to the image files you want thumbnails for.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">format</span>
+      <span class="type">(<tt>:jpeg</tt>, <tt>:png</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The format for the thumbnail image,
+ +

:jpeg (default) or :png. For images that are +photos, :jpeg should be preferred, while png is better for +screenshots and digital arts. The default is :jpeg.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">size</span>
+  <span class="type">(<tt>:w32h32</tt>, <tt>:w64h64</tt>, <tt>:w128h128</tt>, <tt>:w640h480</tt>, <tt>:w1024h768</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>The size for the thumbnail image. The default is <code>:w64h64</code>.</p>
+ +

</div>

+ +
</li>
+
+<li>
+  <span class="name">mode</span>
+  <span class="type">(<tt>:strict</tt>, <tt>:bestfit</tt>, <tt>:fitone_bestfit</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>How to resize and crop the image to achieve the desired size. The default
+ +

for this union is strict.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns files
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

9 10 11 12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_thumbnail_batch_spec.rb', line 23</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_thumbnail_batch'>get_thumbnail_batch</span> +<span class='lbracket'>[</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/img.png</span><span +class='tstring_end'>&quot;</span></span><span +class='rbracket'>]</span> <span class='id +identifier rubyid_entry'>entry</span> <span +class='op'>=</span> <span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_entries'>entries</span><span +class='period'>.</span><span class='id identifier +rubyid_first'>first</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_entry'>entry</span><span +class='period'>.</span><span class='id identifier +rubyid_metadata'>metadata</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_entry'>entry</span><span +class='period'>.</span><span class='id identifier +rubyid_thumbnail'>thumbnail</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'>String</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_entry'>entry</span><span +class='period'>.</span><span class='id identifier +rubyid_metadata'>metadata</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>img.png</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  includes an error entry if the file can&#39;t be found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_thumbnail_batch_spec.rb', line 23</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_thumbnail_batch'>get_thumbnail_batch</span> +<span class='lbracket'>[</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/unknown_file.jpg</span><span +class='tstring_end'>&quot;</span></span><span +class='rbracket'>]</span> <span class='id +identifier rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_entries'>entries</span><span +class='period'>.</span><span class='id identifier +rubyid_first'>first</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an argument error with invalid options
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

23 24 25</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/get_thumbnail_batch_spec.rb', line 23</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_thumbnail_batch'>get_thumbnail_batch</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/img.png</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>invalid_arg:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>value</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'>ArgumentError</span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

23 24 25 26 27 28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb', line 23</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_thumbnail_batch</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_paths'>paths</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='comma'>,</span> <span class='symbol'>:size</span><span class='comma'>,</span> <span class='symbol'>:mode</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:jpeg</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:size</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:w64h64</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:mode</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:strict</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>entries:</span> <span class='id identifier rubyid_build_entries_params'>build_entries_params</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="list_file_members-instance_method">
+
+  #<strong>list_file_members</strong>(file_id, actions = [], options = {})  &#x21d2; <tt>SharedFileMembers</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Use to obtain the members who have been invited to a file, both
+ +

inherited and uninherited members.</p>

+ +

<p>Apps must have full Dropbox access to use this endpoint.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+      <p class="example_title"><div class='inline'><p>List file members.</p>
+ +

</div></p>

+ +
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_file_members'>list_file_members</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>&quot;</span></span></code></pre>
+
+  <p class="example_title"><div class='inline'><p>List file members, with detail of permission to make owner.</p>
+ +

</div></p>

+ +
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_file_members'>list_file_members</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:make_owner</span><span class='rbracket'>]</span></code></pre>
+
+  <p class="example_title"><div class='inline'><p>List file members, using the path instead of file ID.</p>
+ +

</div></p>

+ +
    <pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_file_members'>list_file_members</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/my/file.pdf</span><span class='tstring_end'>&quot;</span></span></code></pre>
+
+</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>file_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The ID for the shared file.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>actions</span>
+
+    <span class='type'>(<tt>Array</tt>)</span>
+
+    <em class="default">(defaults to: <tt>[]</tt>)</em>
+
+    &mdash;
+    <div class='inline'><p>This is an optional list of actions. The permissions for the actions
+ +

requested will be included in the result.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">include_inherited</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Whether to include members
+ +

who only have access from a parent shared folder. The default for this +field is true.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">limit</span>
+  <span class="type">(<tt>Numeric</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>The maximum number of results that
+ +

include members, groups and invitees to return per request. The default for +this field is 100.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>SharedFileMembers</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Shared file user and group membership.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li><span class='object_link'><a href="Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">Metadata::MemberActionList</a></span></li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      lists file members
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_file_members_spec.rb', line 37</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_file_members'>list_file_members</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>1231273663</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/SharedFileMembers.html” +title=“DropboxApi::Results::SharedFileMembers +(class)”>SharedFileMembers</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  lists file members including member actions
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_file_members_spec.rb', line 37</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_file_members'>list_file_members</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>1231273663</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='lbracket'>[</span><span +class='symbol'>:remove</span><span +class='comma'>,</span> <span +class='symbol'>:make_owner</span><span +class='rbracket'>]</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/SharedFileMembers.html” +title=“DropboxApi::Results::SharedFileMembers +(class)”>SharedFileMembers</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

37 38 39 40 41 42 43 44 45</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/list_file_members.rb', line 37</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_file_members</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_file_id'>file_id</span><span +class='comma'>,</span> <span class='id identifier +rubyid_actions'>actions</span> <span +class='op'>=</span> <span +class='lbracket'>[</span><span +class='rbracket'>]</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='comma'>,</span> <span class='symbol'>:include_inherited</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>100</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>file:</span> <span class='id identifier rubyid_file_id'>file_id</span><span class='comma'>,</span>
+  <span class='label'>actions:</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">MemberActionList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Metadata/MemberActionList.html#initialize-instance_method" title="DropboxApi::Metadata::MemberActionList#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_actions'>actions</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="list_folder-instance_method">
+
+  #<strong>list_folder</strong>(path, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the contents of a folder.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to the folder you want to read.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">recursive</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If <code>true</code>, the list folder operation
+ +

will be applied recursively to all subfolders and the response will contain +contents of all subfolders. The default for this field is +false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">include_media_info</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>, media_info
+ +

is set for photo and video. The default for this field is +false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">include_deleted</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>,
+ +

<span class='object_link'><a href=“Metadata/Deleted.html” +title=“DropboxApi::Metadata::Deleted +(class)”>Metadata::Deleted</a></span> will be returned for +deleted file or folder, otherwise <span +class='object_link'><a href=“Errors/NotFoundError.html” +title=“DropboxApi::Errors::NotFoundError +(class)”>Errors::NotFoundError</a></span> will be raised. +The default for this field is false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">limit</span>
+  <span class="type">(<tt>Numeric</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If present, will specify max number of
+ +

results per request (Note: <a href=“www.dropbox.com/developers/documentation/http/documentation#files-list_folder” +target=“_parent” title=“Dropbox docs”>Dropbox docs</a> indicate +this is &quot;approximate&quot;, and more may be +returned)</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns a ListFolderResult
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder'>list_folder</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/ListFolderResult.html” +title=“DropboxApi::Results::ListFolderResult +(class)”>ListFolderResult</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the file can&#39;t be found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/unexisting_folder</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns all entries as metadata objects
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

20 21 22 23 24</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder'>list_folder</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_entries'>entries</span><span +class='period'>.</span><span class='id identifier +rubyid_each'>each</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_resource'>resource</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  lists entries in shared folder if given
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

28 29 30 31 32 33 34</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_shared_links'>list_shared_links</span><span +class='lparen'>(</span><span +class='label'>path:</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/shared_folder</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_result'>result</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder'>list_folder</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='label'>shared_> +<span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_links'>links</span><span +class='period'>.</span><span class='id identifier +rubyid_first'>first</span><span +class='period'>.</span><span class='id identifier +rubyid_url'>url</span>

+ +

<span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_entries'>entries</span><span +class='period'>.</span><span class='id identifier +rubyid_each'>each</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_resource'>resource</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span> <span class='id +identifier rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_entries'>entries</span><span +class='period'>.</span><span class='id identifier +rubyid_map'>map</span><span +class='lparen'>(</span><span +class='op'>&amp;</span><span +class='symbol'>:name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_inspect'>inspect</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_include'>include</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>cow.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an argument error with invalid options
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

38 39 40</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/img.png</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>invalid_arg:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>value</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'>ArgumentError</span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  works with a namespace_id
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

45 46</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+ +

<span class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_namespace_id'>namespace_id</span> <span +class='op'>=</span> <span +class='int'>70721710</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder'>list_folder</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/dropbox_api_fixtures</span><span +class='tstring_end'>&#39;</span></span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  fails with an invalid namespace ID
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

50 51 52 53 54</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+ +

<span class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_namespace_id'>namespace_id</span> <span +class='op'>=</span> <span +class='int'>938429923</span>

+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='kw'>do</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/dropbox_api_fixtures</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='kw'>end</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/HttpError.html” title=“DropboxApi::Errors::HttpError +(class)”>HttpError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  works if namespace ID is unset 
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

58 59 60 61 62 63 64 65</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 29</span>
+ +

<span class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_namespace_id'>namespace_id</span> <span +class='op'>=</span> <span +class='int'>70721710</span>

+ +

<span class='comment'># we expect this to use a namespace ID +</span><span class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder'>list_folder</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/dropbox_api_fixtures</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_namespace_id'>namespace_id</span> <span +class='op'>=</span> <span +class='kw'>nil</span> <span +class='comment'># we expect the next not to use any namespace ID +</span><span class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder'>list_folder</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/dropbox_api_fixtures</span><span +class='tstring_end'>&#39;</span></span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder.rb', line 29</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_folder</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:recursive</span><span class='comma'>,</span>
+  <span class='symbol'>:include_media_info</span><span class='comma'>,</span>
+  <span class='symbol'>:include_deleted</span><span class='comma'>,</span>
+  <span class='symbol'>:shared_link</span><span class='comma'>,</span>
+  <span class='symbol'>:include_has_explicit_shared_members</span><span class='comma'>,</span>
+  <span class='symbol'>:limit</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:recursive</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_media_info</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_deleted</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_build_shared_link_param'>build_shared_link_param</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="list_folder_continue-instance_method">
+
+  #<strong>list_folder_continue</strong>(cursor)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Once a cursor has been retrieved from <code>list_folder</code>, use this to paginate
+ +

through all files and retrieve updates to the folder.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>cursor</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The cursor returned by your last call to
+ +

list_folder or list_folder_continue.</p> </div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns a ListFolderResult
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_continue_spec.rb', line 17</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder_continue'>list_folder_continue</span><span +class='lparen'>(</span><span +class='ivar'>@cursor</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/ListFolderResult.html” +title=“DropboxApi::Results::ListFolderResult +(class)”>ListFolderResult</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder_continue.rb', line 17</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_folder_continue</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="list_folder_get_latest_cursor-instance_method">
+
+  #<strong>list_folder_get_latest_cursor</strong>(options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>A way to quickly get a cursor for the folder&#39;s state. Unlike
+ +

<span class='object_link'><a +href=“#list_folder-instance_method” title=“DropboxApi::Client#list_folder +(method)”>#list_folder</a></span>, this doesn&#39;t +return any entries. This endpoint is for app which only needs to know about +new files and modifications and doesn&#39;t need to know about files +that already exist in Dropbox.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">path</span>
+      <span class="type">(<tt>String</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The path to the folder you want to read.</p>
+ +

</div>

+ +
</li>
+
+<li>
+  <span class="name">recursive</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>, the list folder operation
+ +

will be applied recursively to all subfolders and the response will contain +contents of all subfolders. The default for this field is +false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">include_media_info</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>, <code>media_info</code> is
+ +

set for photo and video. The default for this field is +false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">include_deleted</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>,
+ +

<span class='object_link'><a href=“Metadata/Deleted.html” +title=“DropboxApi::Metadata::Deleted +(class)”>Metadata::Deleted</a></span> will be returned for +deleted file or folder, otherwise <span +class='object_link'><a href=“Errors/LookupError.html” +title=“DropboxApi::Errors::LookupError +(class)”>Errors::LookupError</a></span> will be returned. +The default for this field is false.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns a ListFolderGetLatestCursorResult
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

14 15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_get_latest_cursor_spec.rb', line 28</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder_get_latest_cursor'>list_folder_get_latest_cursor</span> +<span class='label'>path:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/folder</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Results/ListFolderGetLatestCursorResult.html" title="DropboxApi::Results::ListFolderGetLatestCursorResult (class)">ListFolderGetLatestCursorResult</a></span></span><span class='rparen'>)</span></pre>
+          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

28 29 30 31 32 33 34 35 36 37 38 39 40 41</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb', line 28</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_folder_get_latest_cursor</span> +<span class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:path</span><span class='comma'>,</span>
+  <span class='symbol'>:recursive</span><span class='comma'>,</span>
+  <span class='symbol'>:include_media_info</span><span class='comma'>,</span>
+  <span class='symbol'>:include_deleted</span><span class='comma'>,</span>
+  <span class='symbol'>:include_has_explicit_shared_members</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:recursive</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_media_info</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_deleted</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="list_folder_longpoll-instance_method">
+
+  #<strong>list_folder_longpoll</strong>(cursor, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>A longpoll endpoint to wait for changes on an account. In conjunction
+ +

with list_folder, this call gives you a low-latency way to monitor an +account for file changes. The connection will block until there are changes +available or a timeout occurs. This endpoint is useful mostly for +client-side apps. If you&#39;re looking for server-side notifications, +check out our webhooks documentation.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>cursor</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>A cursor as returned by list_folder or
+ +

list_folder_continue.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">timeout</span>
+      <span class="type">(<tt>Numeric</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>A timeout in seconds. The request will
+ +

block for at most this length of time, plus up to 90 seconds of random +jitter added to avoid the thundering herd problem. Care should be taken +when using this parameter, as some network infrastructure does not support +long timeouts. The default for this field is 30.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns a ListFolderLongpollResult
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_longpoll_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder_longpoll'>list_folder_longpoll</span> +<span class='ivar'>@cursor</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/ListFolderLongpollResult.html” +title=“DropboxApi::Results::ListFolderLongpollResult +(class)”>ListFolderLongpollResult</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  indicates if there&#39;re changes
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_longpoll_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder_longpoll'>list_folder_longpoll</span> +<span class='ivar'>@cursor</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_changes'>changes</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_truthy'>be_truthy</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error with an invalid cursor
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

25 26 27</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_longpoll_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder_longpoll'>list_folder_longpoll</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>I believe in the blerch</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span> <span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/HttpError.html” title=“DropboxApi::Errors::HttpError +(class)”>HttpError</a></span></span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

25 26 27 28 29 30 31 32 33 34</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder_longpoll.rb', line 25</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_folder_longpoll</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:timeout</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>30</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="list_folder_members-instance_method">
+
+  #<strong>list_folder_members</strong>(folder_id, actions = [], options = {})  &#x21d2; <tt>SharedFolderMembers</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns shared folder membership by its folder ID.</p>
+ +

<p>Apps must have full Dropbox access to use this endpoint.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+      <p class="example_title"><div class='inline'><p>List folder members.</p>
+ +

</div></p>

+ +
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder_members'>list_folder_members</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>&quot;</span></span></code></pre>
+
+  <p class="example_title"><div class='inline'><p>List folder members, with detail of permission to make owner.</p>
+ +

</div></p>

+ +
    <pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder_members'>list_folder_members</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:make_owner</span><span class='rbracket'>]</span></code></pre>
+
+</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>folder_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The ID for the shared folder.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>actions</span>
+
+    <span class='type'>(<tt>Array</tt>)</span>
+
+    <em class="default">(defaults to: <tt>[]</tt>)</em>
+
+    &mdash;
+    <div class='inline'><p>This is an optional list of actions. The permissions for the actions
+ +

requested will be included in the result.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">limit</span>
+      <span class="type">(<tt>Numeric</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The maximum number of results that
+ +

include members, groups and invitees to return per request. The default for +this field is 1000.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>SharedFolderMembers</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Shared folder user and group membership.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li><span class='object_link'><a href="Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">Metadata::MemberActionList</a></span></li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      lists folder members
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_folder_members_spec.rb', line 30</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder_members'>list_folder_members</span> +<span class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>1231273663</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/SharedFolderMembers.html” +title=“DropboxApi::Results::SharedFolderMembers +(class)”>SharedFolderMembers</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  lists folder members including member actions
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_folder_members_spec.rb', line 30</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder_members'>list_folder_members</span> +<span class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>1231273663</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='lbracket'>[</span><span +class='symbol'>:remove</span><span +class='comma'>,</span> <span +class='symbol'>:make_owner</span><span +class='rbracket'>]</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/SharedFolderMembers.html” +title=“DropboxApi::Results::SharedFolderMembers +(class)”>SharedFolderMembers</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

30 31 32 33 34 35 36 37 38</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/list_folder_members.rb', line 30</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_folder_members</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_folder_id'>folder_id</span><span +class='comma'>,</span> <span class='id identifier +rubyid_actions'>actions</span> <span +class='op'>=</span> <span +class='lbracket'>[</span><span +class='rbracket'>]</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>100</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>shared_folder_id:</span> <span class='id identifier rubyid_folder_id'>folder_id</span><span class='comma'>,</span>
+  <span class='label'>actions:</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">MemberActionList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Metadata/MemberActionList.html#initialize-instance_method" title="DropboxApi::Metadata::MemberActionList#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_actions'>actions</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="list_revisions-instance_method">
+
+  #<strong>list_revisions</strong>(path, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Return revisions of a file</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to file you want to see the revisions of.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">limit</span>
+      <span class="type">(<tt>Numeric</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The maximum number of revision entries
+ +

returned. The default for this field is 10.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns a ListRevisionsResult
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_revisions_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_revisions'>list_revisions</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/ListRevisionsResult.html” +title=“DropboxApi::Results::ListRevisionsResult +(class)”>ListRevisionsResult</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the file can&#39;t be found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_revisions_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_revisions'>list_revisions</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/unexisting_file</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns all revisions as metadata objects
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

19 20 21 22 23</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_revisions_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_revisions'>list_revisions</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_entries'>entries</span><span +class='period'>.</span><span class='id identifier +rubyid_each'>each</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_resource'>resource</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  indicates if the file has been deleted
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

27 28 29</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/list_revisions_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_revisions'>list_revisions</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_is_deleted?'>is_deleted?</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_truthy'>be_truthy</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18 19 20 21 22 23 24 25</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_revisions.rb', line 16</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_revisions</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:limit</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>10</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="list_shared_links-instance_method">
+
+  #<strong>list_shared_links</strong>(options = {})  &#x21d2; <tt>ListSharedLinksResult</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>List shared links of this user.</p>
+ +

<p>If no path is given or the path is empty, returns a list of all +shared links for the current user.</p>

+ +

<p>If a non-empty path is given, returns a list of all shared links +that allow access to the given path - direct links to the given path and +links to parent folders of the given path. Links to parent folders can be +suppressed by setting direct_only to true.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">path</span>
+      <span class="type">(<tt>String</tt>)</span>
+      <span class="default">
+
+      </span>
+
+    </li>
+
+    <li>
+      <span class="name">cursor</span>
+      <span class="type">(<tt>String</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The cursor returned by your last call.</p>
+ +

</div>

+ +
    </li>
+
+    <li>
+      <span class="name">direct_only</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>ListSharedLinksResult</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns a file link
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_shared_links_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_shared_links'>list_shared_links</span> <span +class='label'>path:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/some_folder/file.txt</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_links'>links</span><span +class='period'>.</span><span class='id identifier +rubyid_last'>last</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/FileLinkMetadata.html” +title=“DropboxApi::Metadata::FileLinkMetadata +(class)”>FileLinkMetadata</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  lists all shared links
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16 17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_shared_links_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_links'>links</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_shared_links'>list_shared_links</span><span +class='lparen'>(</span><span +class='label'>path:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/some_folder/file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_links'>links</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_links'>links</span><span +class='period'>.</span><span class='id identifier +rubyid_map'>map</span> <span +class='op'>&amp;</span><span +class='symbol'>:url</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_match_array'>match_array</span><span +class='lparen'>(</span><span +class='qwords_beg'>%w(</span><span +class='words_sep'>

+ +
</span><span class='tstring_content'>https://www.dropbox.com/sh/5b0bmldpa1qi772/AAAwKkKiTdb1A78bzHCKQLeHa?dl=0</span><span class='words_sep'>
+</span><span class='tstring_content'>https://www.dropbox.com/s/sp5cuhaxfn8126z/file.txt?dl=0</span><span class='words_sep'>
+ +

</span><span +class='tstring_end'>)</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  gets the direct shared link
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

23 24 25 26 27 28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_shared_links_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_links'>links</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_shared_links'>list_shared_links</span><span +class='lparen'>(</span><span +class='lbrace'>{</span>

+ +
<span class='label'>path:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/some_folder/file.txt</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+<span class='label'>direct_only:</span> <span class='kw'>true</span>
+ +

<span class='rbrace'>}</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_links'>links</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_links'>links</span><span +class='period'>.</span><span class='id identifier +rubyid_map'>map</span> <span +class='op'>&amp;</span><span +class='symbol'>:url</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_match_array'>match_array</span><span +class='lparen'>(</span><span +class='qwords_beg'>%w(</span><span +class='words_sep'>

+ +
</span><span class='tstring_content'>https://www.dropbox.com/s/sp5cuhaxfn8126z/file.txt?dl=0</span><span class='words_sep'>
+ +

</span><span +class='tstring_end'>)</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns a folder link
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

36 37 38</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_shared_links_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_shared_links'>list_shared_links</span> <span +class='label'>path:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/some_folder/another_folder</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_links'>links</span><span +class='period'>.</span><span class='id identifier +rubyid_last'>last</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/FolderLinkMetadata.html” +title=“DropboxApi::Metadata::FolderLinkMetadata +(class)”>FolderLinkMetadata</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  lists all shared links
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

42 43 44 45 46 47</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/list_shared_links_spec.rb', line 25</span>
+ +

<span class='id identifier rubyid_links'>links</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_shared_links'>list_shared_links</span><span +class='lparen'>(</span><span +class='label'>path:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/some_folder/another_folder</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_links'>links</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_links'>links</span><span +class='period'>.</span><span class='id identifier +rubyid_map'>map</span> <span +class='op'>&amp;</span><span +class='symbol'>:url</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_match_array'>match_array</span><span +class='lparen'>(</span><span +class='qwords_beg'>%w(</span><span +class='words_sep'>

+ +
</span><span class='tstring_content'>https://www.dropbox.com/sh/5b0bmldpa1qi772/AAAwKkKiTdb1A78bzHCKQLeHa?dl=0</span><span class='words_sep'>
+</span><span class='tstring_content'>https://www.dropbox.com/sh/h3slcnfcs3w7sdk/AADlUYcssd70EWHX3n9CJCWwa?dl=0</span><span class='words_sep'>
+ +

</span><span +class='tstring_end'>)</span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

25 26 27 28 29</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/list_shared_links.rb', line 25</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_shared_links</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:cursor</span><span class='comma'>,</span> <span class='symbol'>:direct_only</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="middleware-instance_method">
+
+  #<strong>middleware</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

21 22 23</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/client.rb', line 21</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_middleware'>middleware</span>

+ +
<span class='ivar'>@connection_builder</span><span class='period'>.</span><span class='id identifier rubyid_middleware'>middleware</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="move-instance_method">
+
+  #<strong>move</strong>(from, to, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Move a file or folder to a different location in the user&#39;s Dropbox.</p>
+ +

<p>If the source path is a folder all its contents will be +moved.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>from</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to be copied or moved.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>to</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox that is the destination.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">autorename</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If there&#39;s a conflict, have the
+ +

Dropbox server try to autorename the file to avoid the conflict. The +default for this field is false.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the moved file on success
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/move_spec.rb', line 20</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_move'>move</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/img.png</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/image.png</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>image.png</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns the moved folder on success
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/move_spec.rb', line 20</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_move'>move</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/folder</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/test/folder</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/Folder.html” title=“DropboxApi::Metadata::Folder +(class)”>Folder</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>folder</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  renames the moved file if required
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

21 22 23 24</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/move_spec.rb', line 20</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_move'>move</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/a.jpg</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/photo.jpg</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='label'>autorename:</span> <span +class='kw'>true</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>photo (1).jpg</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the file can&#39;t be found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/move_spec.rb', line 20</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_move'>move</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/z.jpg</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/b.jpg</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

20 21 22 23 24 25 26 27 28 29 30 31 32</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/move.rb', line 20</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:move</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_from'>from</span><span +class='comma'>,</span> <span class='id identifier +rubyid_to'>to</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='comment'># We&#39;re not implementing support for the `allow_shared_folder` option
+ +

</span> <span class='comment'># because according to +Dropbox&#39;s documentation: &quot;This field is always +</span> <span class='comment'># true for +move&quot;. </span> <span class='id identifier +rubyid_validate_options'>validate_options</span><span +class='lparen'>(</span><span +class='lbracket'>[</span>

+ +
  <span class='symbol'>:autorename</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>from_path:</span> <span class='id identifier rubyid_from'>from</span><span class='comma'>,</span>
+  <span class='label'>to_path:</span> <span class='id identifier rubyid_to'>to</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="namespace_id-instance_method">
+
+  #<strong>namespace_id</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

29 30 31</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/client.rb', line 29</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_namespace_id'>namespace_id</span>

+ +
<span class='ivar'>@connection_builder</span><span class='period'>.</span><span class='id identifier rubyid_namespace_id'>namespace_id</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="namespace_id=-instance_method">
+
+  #<strong>namespace_id=</strong>(value)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

25 26 27</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/client.rb', line 25</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_namespace_id='>namespace_id=</span><span +class='lparen'>(</span><span class='id identifier +rubyid_value'>value</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@connection_builder</span><span class='period'>.</span><span class='id identifier rubyid_namespace_id'>namespace_id</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="permanently_delete-instance_method">
+
+  #<strong>permanently_delete</strong>(path, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Permanently delete the file or folder at a given path.</p>
+ +

<p>See <a href=“https://www.dropbox.com/en/help/40www.dropbox.com/en/help/40”>https://www.dropbox.com/en/help/40>

+ +

<p>Note: This endpoint is only available for Dropbox Business +apps.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to delete.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">parent_rev</span>
+      <span class="type">(<tt>String</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Perform delete if given &quot;rev&quot;
+ +

matches the existing file&#39;s latest &quot;rev&quot;. This +field does not support deleting a folder.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      can&#39;t be tested without a Dropbox Business account :(
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/permanently_delete_spec.rb', line 21</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_permanently_delete'>permanently_delete</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/file.txt</span><span class='tstring_end'>&quot;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/HttpError.html” title=“DropboxApi::Errors::HttpError +(class)”>HttpError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

21 22 23 24 25 26 27</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/permanently_delete.rb', line 21</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:permanently_delete</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:parent_rev</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="restore-instance_method">
+
+  #<strong>restore</strong>(path, rev)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Restore a file to a specific revision</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to the file you want to restore.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>rev</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The revision to restore for the file.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the restored file on success
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/restore_spec.rb', line 13</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_restore'>restore</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>1a6a24061bdd</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error with an invalid revision
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/restore_spec.rb', line 13</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_restore'>restore</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/file.txt</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1a6a24061000</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/InvalidRevisionError.html” +title=“DropboxApi::Errors::InvalidRevisionError +(class)”>InvalidRevisionError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

13 14 15 16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/restore.rb', line 13</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:restore</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_rev'>rev</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
+  <span class='label'>rev:</span> <span class='id identifier rubyid_rev'>rev</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="revoke_shared_link-instance_method">
+
+  #<strong>revoke_shared_link</strong>(url)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Revoke a shared link.</p>
+ +

<p>Note that even after revoking a shared link to a file, the file +may be accessible if there are shared links leading to any of the file +parent folders. </p>

+ +

<p>A successful response indicates that the shared link was +revoked.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>url</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>shared url which needs to be revoked.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      revoke a shared link
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

8</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/revoke_shared_link_spec.rb', line 18</span>
+ +

<span class='id identifier rubyid_link'>link</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_revoke_shared_link'>revoke_shared_link</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>www.dropbox.com/sh/t0ebpiojwy4l1bn/AAAcU6qf20b8R-SG5_PJCBOQa?dl=0 +class='tstring_end'>&#39;</span></span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if link is not found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/revoke_shared_link_spec.rb', line 18</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_revoke_shared_link'>revoke_shared_link</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://www.dropbox.com/sh/t0ebpiojwy4l1bn/AAAcU6qf20b8R-SG5_PJCBOQa?dl=0</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/SharedLinkNotFoundError.html” +title=“DropboxApi::Errors::SharedLinkNotFoundError +(class)”>SharedLinkNotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises access denied error if not permitted
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

20 21 22</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/revoke_shared_link_spec.rb', line 18</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_revoke_shared_link'>revoke_shared_link</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://www.dropbox.com/s/al0w4e11j0e1kp3/file_for_sharing.docx?dl=0</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/SharedLinkAccessDeniedError.html” +title=“DropboxApi::Errors::SharedLinkAccessDeniedError +(class)”>SharedLinkAccessDeniedError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises shared link malformed error if link is malformed
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

26 27 28</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/revoke_shared_link_spec.rb', line 18</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_revoke_shared_link'>revoke_shared_link</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://www.dropbox.com/al0w4e11j0e1kp3/file_for_sharing.docx?dl=0</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/SharedLinkMalformedError.html” +title=“DropboxApi::Errors::SharedLinkMalformedError +(class)”>SharedLinkMalformedError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

18 19 20 21 22</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb', line 18</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:revoke_shared_link</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_url'>url</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="save_url-instance_method">
+
+  #<strong>save_url</strong>(path, url)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Save a specified URL into a file in user&#39;s Dropbox. If the given path
+ +

already exists, the file will be renamed to avoid the conflict (e.g. myfile +(1).txt).</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path in Dropbox where the URL will be saved to.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>url</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The URL to be saved.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'></span>
+
+    <div class='inline'><p>Either the saved file or a reference to the async job.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the saved file on success
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/save_url_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_save_url'>save_url</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/photo_1.jpg</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>www.dropbox.com/s/834xngq25alcwsi/IMG_8998.JPG?dl=0 +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_async_job_id'>async_job_id</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>VofXAX8DO1sAAAAAAAAD_Q</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns the saved file on success
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/save_url_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_save_url'>save_url</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/photo_2.jpg</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>static1.squarespace.com/static/518aa4bee4b050d373a7e8a2/t/558add71e4b062927077adc6/1435164035794/photo-1427348693976-99e4aca06bb9.jpg +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_async_job_id'>async_job_id</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>VofXAX8DO1sAAAAAAAAD_w</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error with an invalid URL
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/save_url_spec.rb', line 16</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_save_url'>save_url</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/photo_3.jpg</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1a6a24061000</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/InvalidUrlError.html” +title=“DropboxApi::Errors::InvalidUrlError +(class)”>InvalidUrlError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18 19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/save_url.rb', line 16</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:save_url</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_url'>url</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
+  <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="save_url_check_job_status-instance_method">
+
+  #<strong>save_url_check_job_status</strong>(job_id)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Check the status of a <code>save_url</code> job.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>job_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Id of the asynchronous job. This is the value of
+ +

a response returned from the method that launched the job.</p> +</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'></span>
+
+    <div class='inline'><p>The current status of the job.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the saved file if job completed
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/save_url_check_job_status_spec.rb', line 14</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_save_url_check_job_status'>save_url_check_job_status</span> +<span class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>VofXAX8DO1sAAAAAAAAD_Q</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns :in_progress if job not completed
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

13 14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/save_url_check_job_status_spec.rb', line 14</span>
+ +

<span class='id identifier +rubyid_save_url_result'>save_url_result</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_save_url'>save_url</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/file.zip</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>ipv4.download.thinkbroadband.com/1GB.zip +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_status'>status</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_save_url_check_job_status'>save_url_check_job_status</span> +<span class='id identifier +rubyid_save_url_result'>save_url_result</span><span +class='period'>.</span><span class='id identifier +rubyid_async_job_id'>async_job_id</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_status'>status</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='symbol'>:in_progress</span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns a descriptive error if the job failed
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

20 21 22 23 24</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/save_url_check_job_status_spec.rb', line 14</span>
+ +

<span class='id identifier +rubyid_save_url_result'>save_url_result</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_save_url'>save_url</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/missing_file.zip</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>ipv4.download.thinkbroadband.com/not_found.zip +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span> <span +class='comment'># sleep 30 # We may need to wait until job +completes to get its failure </span><span class='id identifier +rubyid_status'>status</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_save_url_check_job_status'>save_url_check_job_status</span> +<span class='id identifier +rubyid_save_url_result'>save_url_result</span><span +class='period'>.</span><span class='id identifier +rubyid_async_job_id'>async_job_id</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_status'>status</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/DownloadFailedError.html” +title=“DropboxApi::Errors::DownloadFailedError +(class)”>DownloadFailedError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

14 15 16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/save_url_check_job_status.rb', line 14</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:save_url_check_job_status</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_job_id'>job_id</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>async_job_id:</span> <span class='id identifier rubyid_job_id'>job_id</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="search-instance_method">
+
+  #<strong>search</strong>(query, options = nil, match_field_options = nil)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Searches for files and folders.</p>
+ +

<p>Note: Recent changes may not immediately be reflected in search +results due to a short delay in indexing.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>query</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The string to search for. May match across
+ +

multiple fields based on the request arguments.</p> </div>

+ +
</li>
+
+<li>
+
+    <span class='name'>options</span>
+
+    <span class='type'>(<tt><span class='object_link'><a href="Metadata/SearchOptions.html" title="DropboxApi::Metadata::SearchOptions (class)">DropboxApi::Metadata::SearchOptions</a></span></tt>)</span>
+
+    <em class="default">(defaults to: <tt>nil</tt>)</em>
+
+    &mdash;
+    <div class='inline'><p>Options for more
+ +

targeted search results. This field is optional.</p> </div>

+ +
</li>
+
+<li>
+
+    <span class='name'>match_field_options</span>
+
+    <span class='type'>(<tt><span class='object_link'><a href="Metadata/SearchMatchFieldOptions.html" title="DropboxApi::Metadata::SearchMatchFieldOptions (class)">DropboxApi::Metadata::SearchMatchFieldOptions</a></span></tt>)</span>
+
+    <em class="default">(defaults to: <tt>nil</tt>)</em>
+
+    &mdash;
+    <div class='inline'><p>Options for search results match fields. This field is optional.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns a list of matching results
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10 11 12</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/search_spec.rb', line 22</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_search'>search</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>findable_file</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/SearchV2Result.html” +title=“DropboxApi::Results::SearchV2Result +(class)”>SearchV2Result</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_match'>match</span> <span +class='op'>=</span> <span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_matches'>matches</span><span +class='period'>.</span><span class='id identifier +rubyid_first'>first</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_match'>match</span><span +class='period'>.</span><span class='id identifier +rubyid_resource'>resource</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>findable_file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_match'>match</span><span +class='period'>.</span><span class='id identifier +rubyid_match_type'>match_type</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='symbol'>:filename</span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an error if the file can&#39;t be found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

16 17 18 19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/search_spec.rb', line 22</span>
+ +

<span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/SearchOptions.html” +title=“DropboxApi::Metadata::SearchOptions +(class)”>SearchOptions</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“Metadata/Base.html#initialize-instance_method” +title=“DropboxApi::Metadata::Base#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span>

+ +
<span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>path</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/bad_folder</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
+ +

<span class='rparen'>)</span>

+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_search'>search</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/image.png</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_matches'>matches</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_empty'>be_empty</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

22 23 24 25 26 27 28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/search.rb', line 22</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:search</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_query'>query</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='kw'>nil</span><span +class='comma'>,</span> <span class='id identifier +rubyid_match_field_options'>match_field_options</span> +<span class='op'>=</span> <span +class='kw'>nil</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span> <span class='rbrace'>}</span>
+
+<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:options</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span> <span class='kw'>unless</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+
+<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:match_field_options</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match_field_options'>match_field_options</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span> <span class='kw'>unless</span> <span class='id identifier rubyid_match_field_options'>match_field_options</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="search_continue-instance_method">
+
+  #<strong>search_continue</strong>(cursor)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>search:2. Used to fetch the next page of results.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>cursor</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The cursor returned by your last call to</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns a SearchResult
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/search_continue_spec.rb', line 19</span>
+ +

<span class='id identifier rubyid_result'>result</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_search_continue'>search_continue</span><span +class='lparen'>(</span><span +class='ivar'>@cursor</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result'>result</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results.html” title=“DropboxApi::Results +(module)”>Results</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Results/SearchV2Result.html” +title=“DropboxApi::Results::SearchV2Result +(class)”>SearchV2Result</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/search_continue.rb', line 19</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:search_continue</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="share_folder-instance_method">
+
+  #<strong>share_folder</strong>(path, options = {})  &#x21d2; <tt><span class='object_link'><a href="Results/ShareFolderLaunch.html" title="DropboxApi::Results::ShareFolderLaunch (class)">DropboxApi::Results::ShareFolderLaunch</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Share a folder with collaborators.</p>
+ +

<p>Most sharing will be completed synchronously. Large folders will +be completed asynchronously. To make testing the async case repeatable, set +force_async.</p>

+ +

<p>If a ShareFolderLaunch.async_job_id is returned, you&#39;ll +need to call check_share_job_status until the action completes to get the +metadata for the folder.</p>

+ +

<p>Apps must have full Dropbox access to use this endpoint.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to the folder to share. If it does not
+ +

exist, then a new one is created.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">member_policy</span>
+      <span class="type">(<tt>:anyone</tt>, <tt>:team</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Who can be a member of
+ +

this shared folder. Only applicable if the current user is on a team. The +default is :anyone.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">acl_update_policy</span>
+  <span class="type">(<tt>:owner</tt>, <tt>:editors</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Who can add and
+ +

remove members of this shared folder. The default is +:owner.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">shared_link_policy</span>
+  <span class="type">(<tt>:anyone</tt>, <tt>:members</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>The policy to
+ +

apply to shared links created for content inside this shared folder. The +current user must be on a team to set this policy to :members. +The default is anyone.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">force_async</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Whether to force the share to
+ +

happen asynchronously. The default for this field is +false.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt><span class='object_link'><a href="Results/ShareFolderLaunch.html" title="DropboxApi::Results::ShareFolderLaunch (class)">DropboxApi::Results::ShareFolderLaunch</a></span></tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Shared folder metadata.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns the shared folder
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/share_folder_spec.rb', line 37</span>
+ +

<span class='id identifier rubyid_folder'>folder</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_share_folder'>share_folder</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/folder_k</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_folder'>folder</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/SharedFolder.html” title=“DropboxApi::Metadata::SharedFolder +(class)”>SharedFolder</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns the shared folder, even if already shared
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/share_folder_spec.rb', line 37</span>
+ +

<span class='id identifier rubyid_folder'>folder</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_share_folder'>share_folder</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/already_shared</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_folder'>folder</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/SharedFolder.html” title=“DropboxApi::Metadata::SharedFolder +(class)”>SharedFolder</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  contains a shared folder id
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

19 20 21 22</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/share_folder_spec.rb', line 37</span>
+ +

<span class='id identifier rubyid_folder'>folder</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_share_folder'>share_folder</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>/folder_k</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_folder'>folder</span><span +class='period'>.</span><span class='id identifier +rubyid_shared_folder_id'>shared_folder_id</span><span +class='period'>.</span><span class='id identifier +rubyid_to_s'>to_s</span><span +class='rparen'>)</span>

+ +
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1236414195</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span></pre>
+          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/share_folder.rb', line 37</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:share_folder</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:member_policy</span><span class='comma'>,</span>
+  <span class='symbol'>:acl_update_policy</span><span class='comma'>,</span>
+  <span class='symbol'>:shared_link_policy</span><span class='comma'>,</span>
+  <span class='symbol'>:force_async</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:member_policy</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:anyone</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:acl_update_policy</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:owner</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link_policy</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:anyone</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:force_async</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='kw'>begin</span>
+  <span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+    <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+  <span class='rbrace'>}</span><span class='rparen'>)</span>
+<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/AlreadySharedError.html" title="DropboxApi::Errors::AlreadySharedError (class)">AlreadySharedError</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_error'>error</span>
+  <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_shared_folder'>shared_folder</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="token_revoke-instance_method">
+
+  #<strong>token_revoke</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Revoke the access token for the current account</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      revokes the token
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/auth/token_revoke_spec.rb', line 11</span>
+ +

<span class='id identifier +rubyid_account'>account</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_token_revoke'>token_revoke</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

11 12 13</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/auth/token_revoke.rb', line 11</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:token_revoke</span> <span +class='kw'>do</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="unshare_file-instance_method">
+
+  #<strong>unshare_file</strong>(file)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Remove all members from this file. Does not remove inherited members.</p>
+ +

<p>A successful response indicates that the file was +unshared.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>file</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path or ID of the file in the user&#39;s Dropbox to unshare.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      unshares the file
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/unshare_file_spec.rb', line 14</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_unshare_file'>unshare_file</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>id:xyz123</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns file access permission error
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/unshare_file_spec.rb', line 14</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_unshare_file'>unshare_file</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id:xyz123</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NoPermissionError.html” +title=“DropboxApi::Errors::NoPermissionError +(class)”>NoPermissionError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  returns email unverified error
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/sharing/unshare_file_spec.rb', line 14</span>
+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_unshare_file'>unshare_file</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id:xyz123</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/EmailUnverifiedError.html” +title=“DropboxApi::Errors::EmailUnverifiedError +(class)”>EmailUnverifiedError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

14 15 16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/unshare_file.rb', line 14</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:unshare_file</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_file'>file</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>file:</span> <span class='id identifier rubyid_file'>file</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="upload-instance_method">
+
+  #<strong>upload</strong>(path, content, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Creates a new file.</p>
+ +

<p>Do not use this to upload a file larger than 150 MB.</p>

+ +

<p>For larger files you can use <span +class='object_link'><a +href=“#upload_by_chunks-instance_method” +title=“DropboxApi::Client#upload_by_chunks +(method)”>#upload_by_chunks</a></span>.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+    <pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
+ +

<span class='id identifier +rubyid_file_content'>file_content</span> <span +class='op'>=</span> <span +class='const'>IO</span><span +class='period'>.</span><span class='id identifier +rubyid_read'>read</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>local_image.png</span><span +class='tstring_end'>&quot;</span></span> +<span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/image.png</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span class='id identifier +rubyid_file_content'>file_content</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Metadata::File: +@name=&quot;image.png&quot; +…&gt;</span></code></pre>

+ +
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
+ +

<span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>Contents of a plain text +file.</span><span +class='tstring_end'>&quot;</span></span> +<span class='comment'>#=&gt; +#&lt;DropboxApi::Metadata::File: @name=&quot;file.txt&quot; +…&gt;</span></code></pre>

+ +
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
+ +

<span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>File contents…</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='symbol'>:mode</span> <span +class='op'>=&gt;</span> <span +class='symbol'>:add</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Metadata::File: +@name=&quot;file (1).txt&quot; +…&gt;</span></code></pre>

+ +
</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to save the file.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>content</span>
+
+    <span class='type'></span>
+
+    &mdash;
+    <div class='inline'><p>The contents of the file that will be uploaded. This
+ +

could be the result of the IO::read method.</p> +</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">mode</span>
+      <span class="type">(<tt><span class='object_link'><a href="Metadata/WriteMode.html" title="DropboxApi::Metadata::WriteMode (class)">DropboxApi::Metadata::WriteMode</a></span></tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Selects what to
+ +

do if the file already exists. The default is add.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">autorename</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If there&#39;s a conflict, as determined
+ +

by mode, have the Dropbox server try to autorename the file to +avoid conflict. The default for this field is false.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">client_modified</span>
+  <span class="type">(<tt>DateTime</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>The value to store as the
+ +

client_modified timestamp. Dropbox automatically records the +time at which the file was written to the Dropbox servers. It can also +record an additional timestamp, provided by Dropbox desktop clients, mobile +clients, and API apps of when the file was actually created or +modified.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">mute</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Normally, users are made aware of any
+ +

file modifications in their Dropbox account via notifications in the client +software. If true, this tells the clients that this +modification shouldn&#39;t result in a user notification. The default +for this field is false.</p> </div>

+ +
      </li>
+
+  </ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li><span class='object_link'><a href="Metadata/WriteMode.html" title="DropboxApi::Metadata::WriteMode (class)">Metadata::WriteMode</a></span></li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      uploads a file
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

8 9 10 11</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_spec.rb', line 50</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Hello Dropbox!</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  works with an IO object
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

15 16 17 18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_spec.rb', line 50</span>
+ +

<span class='id identifier +rubyid_content'>content</span> <span +class='op'>=</span> <span +class='const'>File</span><span +class='period'>.</span><span class='id identifier +rubyid_open'>open</span><span +class='lparen'>(</span><span +class='const'>File</span><span +class='period'>.</span><span class='id identifier +rubyid_join'>join</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxScaffoldBuilder.html” title=“DropboxScaffoldBuilder +(class)”>DropboxScaffoldBuilder</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_fixtures_path'><span class='object_link'><a +href=“../DropboxScaffoldBuilder.html#fixtures_path-class_method” +title=“DropboxScaffoldBuilder.fixtures_path +(method)”>fixtures_path</a></span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_file'>file</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/file_io.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span class='id identifier +rubyid_content'>content</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file_io.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_content_hash'>content_hash</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>709a5cf259366d6ca6b2fa4d3b53c02f5ce2b2764e9d580711e3ffd24d79f5e9</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  uploads a file with `add` write mode
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

24 25 26 27 28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_spec.rb', line 50</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Hola Dropbox!</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='lbrace'>{</span>

+ +
<span class='label'>autorename:</span> <span class='kw'>true</span><span class='comma'>,</span>
+<span class='label'>mode:</span> <span class='symbol'>:add</span>
+ +

<span class='rbrace'>}</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file (1).txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  uploads a file with `overwrite` write mode
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

34 35 36 37 38 39 40</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_spec.rb', line 50</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Hola Dropbox!</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='lbrace'>{</span>

+ +
<span class='label'>autorename:</span> <span class='kw'>true</span><span class='comma'>,</span>
+<span class='label'>mode:</span> <span class='symbol'>:overwrite</span>
+ +

<span class='rbrace'>}</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  uploads a file with `update` write mode
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

44 45 46 47 48 49 50 51</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_spec.rb', line 50</span>
+ +

<span class='id identifier rubyid_rev'>rev</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_metadata'>get_metadata</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_rev'>rev</span> <span class='id identifier +rubyid_file'>file</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Hallo Dropbox!</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='lbrace'>{</span>

+ +
<span class='label'>autorename:</span> <span class='kw'>true</span><span class='comma'>,</span>
+<span class='label'>mode:</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/WriteMode.html" title="DropboxApi::Metadata::WriteMode (class)">WriteMode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Metadata/WriteMode.html#initialize-instance_method" title="DropboxApi::Metadata::WriteMode#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='symbol'>:update</span><span class='comma'>,</span> <span class='id identifier rubyid_rev'>rev</span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  uploads a file with `overwrite` write mode
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

55 56 57 58 59 60 61 62 63</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_spec.rb', line 50</span>
+ +

<span class='id identifier +rubyid_modified_at'>modified_at</span> <span +class='op'>=</span> <span +class='const'>Time</span><span +class='period'>.</span><span class='id identifier +rubyid_utc'>utc</span> <span +class='int'>2016</span><span +class='comma'>,</span> <span +class='int'>12</span><span +class='comma'>,</span> <span +class='int'>25</span><span +class='comma'>,</span> <span +class='int'>12</span><span +class='comma'>,</span> <span +class='int'>0</span>

+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/another_file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Our country is a +mess!</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='lbrace'>{</span>

+ +
<span class='label'>client_modified:</span> <span class='id identifier rubyid_modified_at'>modified_at</span>
+ +

<span class='rbrace'>}</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>another_file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_client_modified'>client_modified</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span class='id identifier +rubyid_modified_at'>modified_at</span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises a DropboxApi::Errors::TooManyWriteOperations exception
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

68 69 70 71 72 73 74 75 76 77 78 79 80</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_spec.rb', line 50</span>
+ +

<span class='id identifier rubyid_errors'>errors</span> +<span class='op'>=</span> <span +class='lbracket'>[</span><span +class='rbracket'>]</span>

+ +

<span class='int'>15</span><span +class='period'>.</span><span class='id identifier +rubyid_times'>times</span><span +class='period'>.</span><span class='id identifier +rubyid_map'>map</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_n'>n</span><span +class='op'>|</span>

+ +
<span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
+  <span class='kw'>begin</span>
+    <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/file_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_n'>n</span><span class='embexpr_end'>}</span><span class='tstring_content'>.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Hello Dropbox!</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+  <span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/TooManyWriteOperationsError.html" title="DropboxApi::Errors::TooManyWriteOperationsError (class)">TooManyWriteOperationsError</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
+    <span class='id identifier rubyid_errors'>errors</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_e'>e</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span><span +class='period'>.</span><span class='id identifier +rubyid_each'>each</span><span +class='lparen'>(</span><span +class='op'>&amp;</span><span +class='symbol'>:join</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_errors'>errors</span><span +class='period'>.</span><span class='id identifier +rubyid_any?'>any?</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_truthy'>be_truthy</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  raises an exception with info to retry
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_spec.rb', line 50</span>
+ +

<span class='id identifier rubyid_errors'>errors</span> +<span class='op'>=</span> <span +class='lbracket'>[</span><span +class='rbracket'>]</span>

+ +

<span class='int'>15</span><span +class='period'>.</span><span class='id identifier +rubyid_times'>times</span><span +class='period'>.</span><span class='id identifier +rubyid_map'>map</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_n'>n</span><span +class='op'>|</span>

+ +
<span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
+  <span class='kw'>begin</span>
+    <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/file_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_n'>n</span><span class='embexpr_end'>}</span><span class='tstring_content'>.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Hello Dropbox!</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+  <span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Errors/TooManyWriteOperationsError.html" title="DropboxApi::Errors::TooManyWriteOperationsError (class)">TooManyWriteOperationsError</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
+    <span class='id identifier rubyid_errors'>errors</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_e'>e</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span><span +class='period'>.</span><span class='id identifier +rubyid_each'>each</span><span +class='lparen'>(</span><span +class='op'>&amp;</span><span +class='symbol'>:join</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_errors'>errors</span><span +class='period'>.</span><span class='id identifier +rubyid_each'>each</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_error'>error</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_retry_after'>retry_after</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'>Numeric</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  uploads a file
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

8 9 10 11</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/virtual/upload_by_chunks_spec.rb', line 50</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload_by_chunks'>upload_by_chunks</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Hello Dropbox!</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  works with an IO object
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

15 16 17 18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/virtual/upload_by_chunks_spec.rb', line 50</span>
+ +

<span class='id identifier +rubyid_content'>content</span> <span +class='op'>=</span> <span +class='const'>File</span><span +class='period'>.</span><span class='id identifier +rubyid_open'>open</span><span +class='lparen'>(</span><span +class='const'>File</span><span +class='period'>.</span><span class='id identifier +rubyid_join'>join</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxScaffoldBuilder.html” title=“DropboxScaffoldBuilder +(class)”>DropboxScaffoldBuilder</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_fixtures_path'><span class='object_link'><a +href=“../DropboxScaffoldBuilder.html#fixtures_path-class_method” +title=“DropboxScaffoldBuilder.fixtures_path +(method)”>fixtures_path</a></span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_file'>file</span> <span +class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload_by_chunks'>upload_by_chunks</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/file_io.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span class='id identifier +rubyid_content'>content</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file_io.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_content_hash'>content_hash</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>709a5cf259366d6ca6b2fa4d3b53c02f5ce2b2764e9d580711e3ffd24d79f5e9</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  uploads a file with `add` write mode
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

24 25 26 27 28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/virtual/upload_by_chunks_spec.rb', line 50</span>
+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload_by_chunks'>upload_by_chunks</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='embexpr_beg'>#{</span><span class='id +identifier rubyid_path_prefix'>path_prefix</span><span +class='embexpr_end'>}</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Hola Dropbox!</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='lbrace'>{</span>

+ +
<span class='label'>autorename:</span> <span class='kw'>true</span><span class='comma'>,</span>
+<span class='label'>mode:</span> <span class='symbol'>:add</span>
+ +

<span class='rbrace'>}</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>file (1).txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

50 51 52 53 54 55 56 57 58 59 60 61</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/upload.rb', line 50</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:upload</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_content'>content</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:mode</span><span class='comma'>,</span>
+  <span class='symbol'>:autorename</span><span class='comma'>,</span>
+  <span class='symbol'>:client_modified</span><span class='comma'>,</span>
+  <span class='symbol'>:mute</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
+<span class='id identifier rubyid_commit_info'>commit_info</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/CommitInfo.html" title="DropboxApi::Metadata::CommitInfo (class)">CommitInfo</a></span></span><span class='period'>.</span><span class='id identifier rubyid_build_from_options'><span class='object_link'><a href="Metadata/CommitInfo.html#build_from_options-class_method" title="DropboxApi::Metadata::CommitInfo.build_from_options (method)">build_from_options</a></span></span> <span class='id identifier rubyid_options'>options</span>
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_commit_info'>commit_info</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="upload_by_chunks-instance_method">
+
+  #<strong>upload_by_chunks</strong>(path, content, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Creates a new file using the <em>upload session</em> endpoints. You can use
+ +

this method to upload files larger than 150 MB.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+    <pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
+ +

<span class='const'>File</span><span +class='period'>.</span><span class='id identifier +rubyid_open'>open</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>large file.avi</span><span +class='tstring_end'>&quot;</span></span> +<span class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_file'>file</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/large file.avi</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_file'>file</span>
+<span class='comment'>#=&gt; #&lt;DropboxApi::Metadata::File: @name=&quot;large file.avi&quot; ...&gt;
+ +

</span><span +class='kw'>end</span></code></pre>

+ +
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
+ +

<span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>File contents…</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='symbol'>:mode</span> <span +class='op'>=&gt;</span> <span +class='symbol'>:add</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Metadata::File: +@name=&quot;file (1).txt&quot; +…&gt;</span></code></pre>

+ +
</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to save the file.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>content</span>
+
+    <span class='type'></span>
+
+    &mdash;
+    <div class='inline'><p>The contents of the file that will be uploaded. This
+ +

could be the result of the IO::read method.</p> +</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>options</span>
+
+    <span class='type'>(<tt>Hash</tt>)</span>
+
+    <em class="default">(defaults to: <tt>{}</tt>)</em>
+
+    &mdash;
+    <div class='inline'><p>a customizable set of options</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">mode</span>
+      <span class="type">(<tt><span class='object_link'><a href="Metadata/WriteMode.html" title="DropboxApi::Metadata::WriteMode (class)">DropboxApi::Metadata::WriteMode</a></span></tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Selects what to
+ +

do if the file already exists. The default is add.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">autorename</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If there&#39;s a conflict, as determined
+ +

by mode, have the Dropbox server try to autorename the file to +avoid conflict. The default for this field is false.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">client_modified</span>
+  <span class="type">(<tt>DateTime</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>The value to store as the
+ +

client_modified timestamp. Dropbox automatically records the +time at which the file was written to the Dropbox servers. It can also +record an additional timestamp, provided by Dropbox desktop clients, mobile +clients, and API apps of when the file was actually created or +modified.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">mute</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Normally, users are made aware of any
+ +

file modifications in their Dropbox account via notifications in the client +software. If true, this tells the clients that this +modification shouldn&#39;t result in a user notification. The default +for this field is false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">chunk_size</span>
+  <span class="type">(<tt>Numeric</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>The size of each upload chunk. It
+ +

defaults to 4 MiB.</p> </div>

+ +
      </li>
+
+  </ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li><span class='object_link'><a href="Metadata/WriteMode.html" title="DropboxApi::Metadata::WriteMode (class)">Metadata::WriteMode</a></span></li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

41 42 43 44 45 46 47 48</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb', line 41</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_upload_by_chunks'>upload_by_chunks</span><span +class='lparen'>(</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_content'>content</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='const'>StringIO</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_content'>content</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_uploader'>uploader</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ChunkedUploader.html" title="DropboxApi::ChunkedUploader (class)">ChunkedUploader</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ChunkedUploader.html#initialize-instance_method" title="DropboxApi::ChunkedUploader#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_uploader'>uploader</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span>
+<span class='id identifier rubyid_uploader'>uploader</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span>
+<span class='id identifier rubyid_uploader'>uploader</span><span class='period'>.</span><span class='id identifier rubyid_finish'>finish</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="upload_session_append_v2-instance_method">
+
+  #<strong>upload_session_append_v2</strong>(cursor, content, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Append more data to an upload session.</p>
+ +

<p>When the parameter close is set, this call will close +the session.</p>

+ +

<p>A single request should not upload more than 150 MB.</p>

+ +

<p>The maximum size of a file one can upload to an upload session is +350 GB.</p>

+ +

<p>Calling this method may update the cursor received. In particular, +the offset variable will be increased to match the new position. This +allows you to make subsequent calls to the endpoint using the same +cursor, as you can see in the example.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+    <pre class="example code"><code># Rely on the offset position updated by `upload_session_append_v2`
+ +

client = DropboxApi::Client.new +cursor = client.upload_session_start(&#39;abc&#39;) # +cursor.offset =&gt; 3 client.upload_session_append_v2(cursor, +&#39;def&#39;) # cursor.offset =&gt; 6 +client.upload_session_append_v2(cursor, &#39;ghi&#39;) # +cursor.offset =&gt; 9 +client.upload_session_finish(…)</code></pre>

+ +
</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>cursor</span>
+
+    <span class='type'>(<tt><span class='object_link'><a href="Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">DropboxApi::Metadata::UploadSessionCursor</a></span></tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Contains the
+ +

upload session ID and the offset. This cursor will have its offset updated +after a successful call.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">close</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If <code>true</code>, the current session will be
+ +

closed, at which point you won&#39;t be able to call <span +class='object_link'><a +href=“#upload_session_append_v2-instance_method” +title=“DropboxApi::Client#upload_session_append_v2 +(method)”>#upload_session_append_v2</a></span> anymore with +the current session. The default for this field is +false.</p> </div>

+ +
      </li>
+
+  </ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li>UploadSessionCursor</li>
+
+</ul>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      can be used to append an upload
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

8 9 10 11 12 13 14 15 16 17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_session_append_v2_spec.rb', line 39</span>
+ +

<span class='id identifier rubyid_chunks'>chunks</span> +<span class='op'>=</span> <span +class='lbracket'>[</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>123456789</span><span +class='tstring_end'>&#39;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Olá Dropbox!</span><span +class='tstring_end'>&#39;</span></span><span +class='rbracket'>]</span>

+ +

<span class='id identifier rubyid_cursor'>cursor</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload_session_start'>upload_session_start</span><span +class='lparen'>(</span><span class='id identifier +rubyid_chunks'>chunks</span><span +class='period'>.</span><span class='id identifier +rubyid_first'>first</span><span +class='rparen'>)</span>

+ +

<span class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload_session_append_v2'>upload_session_append_v2</span><span +class='lparen'>(</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='comma'>,</span> <span class='id identifier +rubyid_chunks'>chunks</span><span +class='period'>.</span><span class='id identifier +rubyid_last'>last</span><span +class='rparen'>)</span>

+ +

<span class='id identifier rubyid_commit'>commit</span> +<span class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/CommitInfo.html” title=“DropboxApi::Metadata::CommitInfo +(class)”>CommitInfo</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“Metadata/Base.html#initialize-instance_method” +title=“DropboxApi::Metadata::Base#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span>

+ +
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>path</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/target.txt</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mode</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='symbol'>:add</span>
+ +

<span class='rparen'>)</span>

+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload_session_finish'>upload_session_finish</span><span +class='lparen'>(</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='comma'>,</span> <span class='id identifier +rubyid_commit'>commit</span><span +class='rparen'>)</span> <span +class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_not_to'>not_to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  will raise error if the cursor can&#39;t be found
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

23 24 25 26 27 28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_session_append_v2_spec.rb', line 39</span>
+ +

<span class='id identifier rubyid_cursor'>cursor</span> +<span class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/UploadSessionCursor.html” +title=“DropboxApi::Metadata::UploadSessionCursor +(class)”>UploadSessionCursor</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“Metadata/Base.html#initialize-instance_method” +title=“DropboxApi::Metadata::Base#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='lbrace'>{</span>

+ +
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>session_id</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>INVALID_CURSOR</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>offset</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='int'>0</span>
+ +

<span class='rbrace'>}</span><span +class='rparen'>)</span>

+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_upload_session_append_v2'>upload_session_append_v2</span><span class='lparen'>(</span><span class='id identifier rubyid_cursor'>cursor</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Hello Dropbox!</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/NotFoundError.html” title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span><span +class='rparen'>)</span></pre>

+ +
      </td>
+    </tr>
+  </table>
+</li>
+
+<li>
+  will raise error if the offset is wrong
+  <table class="source_code test_code">
+    <tr>
+      <td>
+        <pre class="lines">
+ +

34 35 36 37 38 39 40 41 42 43</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_session_append_v2_spec.rb', line 39</span>
+ +

<span class='id identifier rubyid_chunk'>chunk</span> +<span class='op'>=</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>123456789</span><span +class='tstring_end'>&#39;</span></span>

+ +

<span class='id identifier rubyid_cursor'>cursor</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload_session_start'>upload_session_start</span><span +class='lparen'>(</span><span class='id identifier +rubyid_chunk'>chunk</span><span +class='rparen'>)</span>

+ +

<span class='comment'># Set an incorrect offset deliberately +so Dropbox will return an error </span><span class='id +identifier rubyid_cursor'>cursor</span><span +class='period'>.</span><span class='id identifier +rubyid_instance_variable_set'>instance_variable_set</span> +<span class='symbol'>:@offset</span><span +class='comma'>,</span> <span +class='int'>42</span>

+ +

<span class='id identifier rubyid_expect'>expect</span> +<span class='lbrace'>{</span>

+ +
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_upload_session_append_v2'>upload_session_append_v2</span><span class='lparen'>(</span><span class='id identifier rubyid_cursor'>cursor</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Hello Dropbox!</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_raise_error'>raise_error</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Errors/UploadSessionOffsetError.html” +title=“DropboxApi::Errors::UploadSessionOffsetError +(class)”>UploadSessionOffsetError</a></span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

39 40 41 42 43 44 45 46 47 48 49</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/upload_session_append_v2.rb', line 39</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:upload_session_append_v2</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='comma'>,</span> <span class='id identifier +rubyid_content'>content</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:close</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_cursor'>cursor</span><span class='period'>.</span><span class='id identifier rubyid_offset'>offset</span> <span class='op'>+=</span> <span class='id identifier rubyid_content'>content</span><span class='period'>.</span><span class='id identifier rubyid_bytesize'>bytesize</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="upload_session_finish-instance_method">
+
+  #<strong>upload_session_finish</strong>(cursor, commit, content = nil)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Finish an upload session and save the uploaded data to the given file
+ +

path.</p>

+ +

<p>A single request should not upload more than 150 MB.</p>

+ +

<p>The maximum size of a file one can upload to an upload session is +350 GB.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>cursor</span>
+
+    <span class='type'>(<tt><span class='object_link'><a href="Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">DropboxApi::Metadata::UploadSessionCursor</a></span></tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Contains the
+ +

upload session ID and the offset.</p> </div>

+ +
</li>
+
+<li>
+
+    <span class='name'>commit</span>
+
+    <span class='type'>(<tt><span class='object_link'><a href="Metadata/CommitInfo.html" title="DropboxApi::Metadata::CommitInfo (class)">DropboxApi::Metadata::CommitInfo</a></span></tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Contains the path and
+ +

other optional modifiers for the commit.</p> </div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      will create a file
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10 11 12 13 14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_session_finish_spec.rb', line 22</span>
+ +

<span class='id identifier rubyid_cursor'>cursor</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload_session_start'>upload_session_start</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Hello Dropbox!</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_commit'>commit</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/CommitInfo.html” title=“DropboxApi::Metadata::CommitInfo +(class)”>CommitInfo</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“Metadata/Base.html#initialize-instance_method” +title=“DropboxApi::Metadata::Base#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='lbrace'>{</span>

+ +
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>path</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/Homework/math/Matrices.txt</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mode</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='symbol'>:add</span>
+ +

<span class='rbrace'>}</span><span +class='rparen'>)</span>

+ +

<span class='id identifier rubyid_file'>file</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload_session_finish'>upload_session_finish</span><span +class='lparen'>(</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='comma'>,</span> <span class='id identifier +rubyid_commit'>commit</span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_name'>name</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Matrices.txt</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

22 23 24 25 26 27</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/upload_session_finish.rb', line 22</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:upload_session_finish</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='comma'>,</span> <span class='id identifier +rubyid_commit'>commit</span><span +class='comma'>,</span> <span class='id identifier +rubyid_content'>content</span> <span +class='op'>=</span> <span +class='kw'>nil</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span><span class='comma'>,</span>
+  <span class='label'>commit:</span> <span class='id identifier rubyid_commit'>commit</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span>
+<span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="upload_session_start-instance_method">
+
+  #<strong>upload_session_start</strong>(content, options = {})  &#x21d2; <tt><span class='object_link'><a href="Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">DropboxApi::Metadata::UploadSessionCursor</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Upload sessions allow you to upload a single file in one or more
+ +

requests, for example where the size of the file is greater than 150 +MB.</p>

+ +

<p>This call starts a new upload session with the given data. You can +then use <span class='object_link'><a +href=“#upload_session_append_v2-instance_method” +title=“DropboxApi::Client#upload_session_append_v2 +(method)”>#upload_session_append_v2</a></span> to add more +data and <span class='object_link'><a +href=“#upload_session_finish-instance_method” +title=“DropboxApi::Client#upload_session_finish +(method)”>#upload_session_finish</a></span> to save all the +data to a file in Dropbox.</p>

+ +

<p>A single request should not upload more than 150 MB of file +contents.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">close</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If <code>true</code>, the current session will be
+ +

closed, at which point you won&#39;t be able to call <span +class='object_link'><a +href=“#upload_session_append_v2-instance_method” +title=“DropboxApi::Client#upload_session_append_v2 +(method)”>#upload_session_append_v2</a></span> anymore with +the current session. The default for this field is +false.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt><span class='object_link'><a href="Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">DropboxApi::Metadata::UploadSessionCursor</a></span></tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The session cursor
+ +

that you can use to continue the upload afterwards.</p> </div>

+ +
</li>
+ +

</ul>

+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Specifications:</p>
+<ul class="specs">
+
+    <li>
+      returns a session
+      <table class="source_code test_code">
+        <tr>
+          <td>
+            <pre class="lines">
+ +

7 8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/endpoints/files/upload_session_start_spec.rb', line 26</span>
+ +

<span class='id identifier rubyid_cursor'>cursor</span> +<span class='op'>=</span> <span +class='ivar'>@client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload_session_start'>upload_session_start</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>Hello Dropbox!</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_be_a'>be_a</span><span +class='lparen'>(</span><span +class='const'><span class='object_link'><a +href=“../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“Metadata/UploadSessionCursor.html” +title=“DropboxApi::Metadata::UploadSessionCursor +(class)”>UploadSessionCursor</a></span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_expect'>expect</span><span +class='lparen'>(</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='period'>.</span><span class='id identifier +rubyid_session_id'>session_id</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_to'>to</span> <span class='id identifier +rubyid_eq'>eq</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>AAAAAAAMOCK_SESSION_ID</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span></pre>

+ +
          </td>
+        </tr>
+      </table>
+    </li>
+
+</ul>
+ +

</div>

+ +

<table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

26 27 28 29 30 31 32 33 34 35 36 37</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/upload_session_start.rb', line 26</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:upload_session_start</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_content'>content</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:close</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_session'>session</span> <span class='op'>=</span> <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
+
+<span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">UploadSessionCursor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>session_id</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_session_id'>session_id</span><span class='comma'>,</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>offset</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_content'>content</span><span class='period'>.</span><span class='id identifier rubyid_bytesize'>bytesize</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/ConnectionBuilder_html.html b/doc/docs/DropboxApi/ConnectionBuilder_html.html new file mode 100644 index 00000000..c27def1a --- /dev/null +++ b/doc/docs/DropboxApi/ConnectionBuilder_html.html @@ -0,0 +1,1155 @@ + + + + + + +ConnectionBuilder.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::ConnectionBuilder
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::ConnectionBuilder";
+relpath = '../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+   &raquo; 
+  <span class="title">ConnectionBuilder</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::ConnectionBuilder
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::ConnectionBuilder</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/connection_builder.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+<ul class="summary">
+
+    <li class="public ">
+<span class="summary_signature">
+
+    <a href="#namespace_id-instance_method" title="#namespace_id (instance method)">#<strong>namespace_id</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the value of attribute namespace_id.</p>
+ +

</div></span>

+ +

</li>

+ +
</ul>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build-instance_method" title="#build (instance method)">#<strong>build</strong>(url)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#can_refresh_access_token%3F-instance_method" title="#can_refresh_access_token? (instance method)">#<strong>can_refresh_access_token?</strong>  &#x21d2; Boolean </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(oauth_bearer = nil, access_token: nil, on_token_refreshed: nil)  &#x21d2; ConnectionBuilder </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of ConnectionBuilder.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#middleware-instance_method" title="#middleware (instance method)">#<strong>middleware</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#refresh_access_token-instance_method" title="#refresh_access_token (instance method)">#<strong>refresh_access_token</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
</ul>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(oauth_bearer = nil, access_token: nil, on_token_refreshed: nil)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::ConnectionBuilder (class)">ConnectionBuilder</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of ConnectionBuilder.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

6 7 8 9 10 11 12 13 14 15 16 17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 6</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_oauth_bearer'>oauth_bearer</span> <span +class='op'>=</span> <span +class='kw'>nil</span><span +class='comma'>,</span> <span +class='label'>access_token:</span> <span +class='kw'>nil</span><span +class='comma'>,</span> <span +class='label'>on_token_refreshed:</span> <span +class='kw'>nil</span><span +class='rparen'>)</span>

+ +
<span class='kw'>if</span> <span class='id identifier rubyid_access_token'>access_token</span>
+  <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_access_token'>access_token</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>OAuth2</span><span class='op'>::</span><span class='const'>AccessToken</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>access_token should be an OAuth2::AccessToken</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+
+  <span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='id identifier rubyid_access_token'>access_token</span>
+  <span class='ivar'>@on_token_refreshed</span> <span class='op'>=</span> <span class='id identifier rubyid_on_token_refreshed'>on_token_refreshed</span>
+<span class='kw'>elsif</span> <span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span>
+  <span class='ivar'>@oauth_bearer</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth_bearer'>oauth_bearer</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Either oauth_bearer or access_token should be set</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="instance_attr_details" class="attr_details">
+  <h2>Instance Attribute Details</h2>
+
+    <span id="namespace_id=-instance_method"></span>
+    <div class="method_details first">
+<h3 class="signature first" id="namespace_id-instance_method">
+
+  #<strong>namespace_id</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the value of attribute namespace_id.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_namespace_id'>namespace_id</span>

+ +
<span class='ivar'>@namespace_id</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+
+<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build-instance_method">
+
+  #<strong>build</strong>(url)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

44 45 46 47 48 49 50 51 52 53 54</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 44</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build'>build</span><span +class='lparen'>(</span><span class='id identifier +rubyid_url'>url</span><span +class='rparen'>)</span>

+ +
<span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_connection'>connection</span><span class='op'>|</span>
+  <span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="MiddleWare.html" title="DropboxApi::MiddleWare (module)">MiddleWare</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="MiddleWare/PathRoot.html" title="DropboxApi::MiddleWare::PathRoot (class)">PathRoot</a></span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
+    <span class='label'>namespace_id:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_namespace_id'>namespace_id</span>
+  <span class='rbrace'>}</span>
+  <span class='id identifier rubyid_middleware'>middleware</span><span class='period'>.</span><span class='id identifier rubyid_apply'>apply</span><span class='lparen'>(</span><span class='id identifier rubyid_connection'>connection</span><span class='rparen'>)</span> <span class='kw'>do</span>
+    <span class='id identifier rubyid_connection'>connection</span><span class='period'>.</span><span class='id identifier rubyid_authorization'>authorization</span> <span class='symbol'>:Bearer</span><span class='comma'>,</span> <span class='id identifier rubyid_bearer'>bearer</span>
+    <span class='kw'>yield</span> <span class='id identifier rubyid_connection'>connection</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="can_refresh_access_token?-instance_method">
+
+  #<strong>can_refresh_access_token?</strong>  &#x21d2; <tt>Boolean</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+
+</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>Boolean</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

25 26 27</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 25</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_can_refresh_access_token?'>can_refresh_access_token?</span>

+ +
<span class='ivar'>@access_token</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@access_token</span><span class='period'>.</span><span class='id identifier rubyid_refresh_token'>refresh_token</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="middleware-instance_method">
+
+  #<strong>middleware</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

21 22 23</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 21</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_middleware'>middleware</span>

+ +
<span class='ivar'>@middleware</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="MiddleWare.html" title="DropboxApi::MiddleWare (module)">MiddleWare</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="MiddleWare/Stack.html" title="DropboxApi::MiddleWare::Stack (class)">Stack</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="MiddleWare/Stack.html#initialize-instance_method" title="DropboxApi::MiddleWare::Stack#initialize (method)">new</a></span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="refresh_access_token-instance_method">
+
+  #<strong>refresh_access_token</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

29 30 31 32</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/connection_builder.rb', line 29</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_refresh_access_token'>refresh_access_token</span>

+ +
<span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='ivar'>@access_token</span><span class='period'>.</span><span class='id identifier rubyid_refresh!'>refresh!</span>
+<span class='ivar'>@on_token_refreshed</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='ivar'>@access_token</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@on_token_refreshed</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Auth/TokenRevoke_html.html b/doc/docs/DropboxApi/Endpoints/Auth/TokenRevoke_html.html new file mode 100644 index 00000000..860db961 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Auth/TokenRevoke_html.html @@ -0,0 +1,920 @@ + + + + + + +TokenRevoke.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Auth::TokenRevoke
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Auth::TokenRevoke";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Auth.html" title="DropboxApi::Endpoints::Auth (module)">Auth</a></span></span>
+   &raquo; 
+  <span class="title">TokenRevoke</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Auth::TokenRevoke
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Auth::TokenRevoke</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/auth/token_revoke.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/auth/token/revoke</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/VoidResult.html" title="DropboxApi::Results::VoidResult (class)">VoidResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='kw'>nil</span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#token_revoke-instance_method" title="#token_revoke (instance method)">#<strong>token_revoke</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Revoke the access token for the current account.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="token_revoke-instance_method">
+
+  #<strong>token_revoke</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Revoke the access token for the current account</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

11 12 13</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/auth/token_revoke.rb', line 11</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:token_revoke</span> <span +class='kw'>do</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Auth_html.html b/doc/docs/DropboxApi/Endpoints/Auth_html.html new file mode 100644 index 00000000..b7e5c8b2 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Auth_html.html @@ -0,0 +1,796 @@ + + + + + + +Auth.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Module: DropboxApi::Endpoints::Auth
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Auth";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (A)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span>
+   &raquo; 
+  <span class="title">Auth</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Module: DropboxApi::Endpoints::Auth
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/auth/token_revoke.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Defined Under Namespace</h2> <p class=“children”>

+ +
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Auth/TokenRevoke.html" title="DropboxApi::Endpoints::Auth::TokenRevoke (class)">TokenRevoke</a></span>
+ +

</p>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Base_html.html b/doc/docs/DropboxApi/Endpoints/Base_html.html new file mode 100644 index 00000000..c566a399 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Base_html.html @@ -0,0 +1,948 @@ + + + + + + +Base.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Base
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Base";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (B)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span>
+   &raquo; 
+  <span class="title">Base</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Base
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::Endpoints::Base</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/base.rb</dd>
+</dl>
+ +

</div>

+ +

<div id=“subclasses”>

+ +
<h2>Direct Known Subclasses</h2>
+<p class="children"><span class='object_link'><a href="ContentDownload.html" title="DropboxApi::Endpoints::ContentDownload (class)">ContentDownload</a></span>, <span class='object_link'><a href="ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span>, <span class='object_link'><a href="Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></p>
+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#add_endpoint-class_method" title="add_endpoint (class method)">.<strong>add_endpoint</strong>(name, &amp;block)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(builder)  &#x21d2; Base </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of Base.</p>
+ +

</div></span>

+ +

</li>

+ +
</ul>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(builder)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Endpoints::Base (class)">Base</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of Base.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/base.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_builder'>builder</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@builder</span> <span class='op'>=</span> <span class='id identifier rubyid_builder'>builder</span>
+<span class='id identifier rubyid_build_connection'>build_connection</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="add_endpoint-class_method">
+
+  .<strong>add_endpoint</strong>(name, &amp;block)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

9 10 11 12</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/base.rb', line 9</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_add_endpoint'>add_endpoint</span><span +class='lparen'>(</span><span class='id identifier +rubyid_name'>name</span><span +class='comma'>,</span> <span +class='op'>&amp;</span><span class='id +identifier rubyid_block'>block</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_define_method'>define_method</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+<span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_add_endpoint'>add_endpoint</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='kw'>self</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/ContentDownload_html.html b/doc/docs/DropboxApi/Endpoints/ContentDownload_html.html new file mode 100644 index 00000000..c2780c8f --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/ContentDownload_html.html @@ -0,0 +1,1007 @@ + + + + + + +ContentDownload.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::ContentDownload
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::ContentDownload";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span>
+   &raquo; 
+  <span class="title">ContentDownload</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::ContentDownload
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::ContentDownload</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/content_download.rb</dd>
+</dl>
+ +

</div>

+ +

<div id=“subclasses”>

+ +
<h2>Direct Known Subclasses</h2>
+<p class="children"><span class='object_link'><a href="Files/Download.html" title="DropboxApi::Endpoints::Files::Download (class)">Files::Download</a></span>, <span class='object_link'><a href="Files/GetPreview.html" title="DropboxApi::Endpoints::Files::GetPreview (class)">Files::GetPreview</a></span>, <span class='object_link'><a href="Files/GetThumbnail.html" title="DropboxApi::Endpoints::Files::GetThumbnail (class)">Files::GetThumbnail</a></span></p>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_connection-instance_method" title="#build_connection (instance method)">#<strong>build_connection</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_request-instance_method" title="#build_request (instance method)">#<strong>build_request</strong>(params)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#perform_request-instance_method" title="#perform_request (instance method)">#<strong>perform_request</strong>(params) {|response.body| ... } &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build_connection-instance_method">
+
+  #<strong>build_connection</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/content_download.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_connection'>build_connection</span>

+ +
<span class='ivar'>@connection</span> <span class='op'>=</span> <span class='ivar'>@builder</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://content.dropboxapi.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
+  <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='symbol'>:decode_result</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_request-instance_method">
+
+  #<strong>build_request</strong>(params)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

10 11 12 13 14 15 16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/content_download.rb', line 10</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_request'>build_request</span><span +class='lparen'>(</span><span class='id identifier +rubyid_params'>params</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='kw'>nil</span>
+<span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Dropbox-API-Arg</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='comma'>,</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
+<span class='rbrace'>}</span>
+
+<span class='kw'>return</span> <span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="perform_request-instance_method">
+
+  #<strong>perform_request</strong>(params) {|response.body| ... } &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+
+</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Yields:</p> <ul class=“yield”>

+ +
<li>
+
+    <span class='type'>(<tt>response.body</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

20 21 22 23 24 25 26 27 28 29</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/content_download.rb', line 20</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_perform_request'>perform_request</span><span +class='lparen'>(</span><span class='id identifier +rubyid_params'>params</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_get_response'>get_response</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_api_result'>api_result</span> <span class='op'>=</span> <span class='id identifier rubyid_process_response'>process_response</span> <span class='id identifier rubyid_response'>response</span>
+
+<span class='comment'># We just yield the whole response to the block, it&#39;d be nice in the
+ +

</span> <span class='comment'># future to support an +interface that streams the response in chunks. </span> <span +class='kw'>yield</span> <span class='id identifier +rubyid_response'>response</span><span +class='period'>.</span><span class='id identifier +rubyid_body'>body</span> <span +class='kw'>if</span> <span class='id identifier +rubyid_block_given?'>block_given?</span>

+ +
<span class='id identifier rubyid_api_result'>api_result</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/ContentUpload_html.html b/doc/docs/DropboxApi/Endpoints/ContentUpload_html.html new file mode 100644 index 00000000..f388457b --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/ContentUpload_html.html @@ -0,0 +1,981 @@ + + + + + + +ContentUpload.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::ContentUpload
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::ContentUpload";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span>
+   &raquo; 
+  <span class="title">ContentUpload</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::ContentUpload
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::ContentUpload</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/content_upload.rb</dd>
+</dl>
+ +

</div>

+ +

<div id=“subclasses”>

+ +
<h2>Direct Known Subclasses</h2>
+<p class="children"><span class='object_link'><a href="Files/Upload.html" title="DropboxApi::Endpoints::Files::Upload (class)">Files::Upload</a></span>, <span class='object_link'><a href="Files/UploadSessionAppendV2.html" title="DropboxApi::Endpoints::Files::UploadSessionAppendV2 (class)">Files::UploadSessionAppendV2</a></span>, <span class='object_link'><a href="Files/UploadSessionFinish.html" title="DropboxApi::Endpoints::Files::UploadSessionFinish (class)">Files::UploadSessionFinish</a></span>, <span class='object_link'><a href="Files/UploadSessionStart.html" title="DropboxApi::Endpoints::Files::UploadSessionStart (class)">Files::UploadSessionStart</a></span></p>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_connection-instance_method" title="#build_connection (instance method)">#<strong>build_connection</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_request-instance_method" title="#build_request (instance method)">#<strong>build_request</strong>(params, body)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#perform_request-instance_method" title="#perform_request (instance method)">#<strong>perform_request</strong>(params, content)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build_connection-instance_method">
+
+  #<strong>build_connection</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/content_upload.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_connection'>build_connection</span>

+ +
<span class='ivar'>@connection</span> <span class='op'>=</span> <span class='ivar'>@builder</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://content.dropboxapi.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
+  <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='symbol'>:decode_result</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_request-instance_method">
+
+  #<strong>build_request</strong>(params, body)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

10 11 12 13 14 15 16 17 18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/content_upload.rb', line 10</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_request'>build_request</span><span +class='lparen'>(</span><span class='id identifier +rubyid_params'>params</span><span +class='comma'>,</span> <span class='id identifier +rubyid_body'>body</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Dropbox-API-Arg</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='comma'>,</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Type</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/octet-stream</span><span class='tstring_end'>&#39;</span></span>
+<span class='rbrace'>}</span>
+
+<span class='id identifier rubyid_content_length'>content_length</span> <span class='op'>=</span> <span class='id identifier rubyid_get_content_length'>get_content_length</span> <span class='id identifier rubyid_body'>body</span>
+<span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content-Length</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_content_length'>content_length</span> <span class='kw'>unless</span> <span class='id identifier rubyid_content_length'>content_length</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+
+<span class='kw'>return</span> <span class='id identifier rubyid_body'>body</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="perform_request-instance_method">
+
+  #<strong>perform_request</strong>(params, content)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

22 23 24</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/content_upload.rb', line 22</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_perform_request'>perform_request</span><span +class='lparen'>(</span><span class='id identifier +rubyid_params'>params</span><span +class='comma'>,</span> <span class='id identifier +rubyid_content'>content</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_process_response'>process_response</span><span class='lparen'>(</span><span class='id identifier rubyid_get_response'>get_response</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/CopyBatchCheck_html.html b/doc/docs/DropboxApi/Endpoints/Files/CopyBatchCheck_html.html new file mode 100644 index 00000000..11c31696 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/CopyBatchCheck_html.html @@ -0,0 +1,960 @@ + + + + + + +CopyBatchCheck.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::CopyBatchCheck
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::CopyBatchCheck";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">CopyBatchCheck</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::CopyBatchCheck
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::CopyBatchCheck</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/copy_batch_check.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/copy_batch/check_v2</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/RelocationBatchResult.html" title="DropboxApi::Results::RelocationBatchResult (class)">RelocationBatchResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/PollError.html" title="DropboxApi::Errors::PollError (class)">PollError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#copy_batch_check-instance_method" title="#copy_batch_check (instance method)">#<strong>copy_batch_check</strong>(async_job_id)  &#x21d2; :in_progress, Array </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for <span class='object_link'><a href="../../Client.html#copy_batch-instance_method" title="DropboxApi::Client#copy_batch (method)">Client#copy_batch</a></span>.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="copy_batch_check-instance_method">
+
+  #<strong>copy_batch_check</strong>(async_job_id)  &#x21d2; <tt>:in_progress</tt>, <tt>Array</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the status of an asynchronous job for <span class='object_link'><a href="../../Client.html#copy_batch-instance_method" title="DropboxApi::Client#copy_batch (method)">Client#copy_batch</a></span>. It
+ +

returns a list of results for each entry.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>async_job_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Id of the asynchronous job.
+ +

This is the value of a response returned from the method that launched the +job.</p> </div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>:in_progress</tt>, <tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>This could be either the <code>:in_progress</code>
+ +

flag or a list of job statuses.</p> </div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_batch_check.rb', line 17</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:copy_batch_check</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_async_job_id'>async_job_id</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>async_job_id:</span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/CopyBatch_html.html b/doc/docs/DropboxApi/Endpoints/Files/CopyBatch_html.html new file mode 100644 index 00000000..93e83e75 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/CopyBatch_html.html @@ -0,0 +1,1004 @@ + + + + + + +CopyBatch.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::CopyBatch
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::CopyBatch";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">CopyBatch</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::CopyBatch
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::CopyBatch</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/copy_batch.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/copy_batch_v2</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/CopyBatchResult.html" title="DropboxApi::Results::CopyBatchResult (class)">CopyBatchResult</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#copy_batch-instance_method" title="#copy_batch (instance method)">#<strong>copy_batch</strong>(entries, options = {})  &#x21d2; String, Array </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Copy multiple files or folders to different locations at once in the user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="copy_batch-instance_method">
+
+  #<strong>copy_batch</strong>(entries, options = {})  &#x21d2; <tt>String</tt>, <tt>Array</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Copy multiple files or folders to different locations at once in the
+ +

user&#39;s Dropbox.</p>

+ +

<p>This will either finish synchronously, or return a job ID and do +the async copy job in background. Please use <span +class='object_link'><a +href=“../../Client.html#copy_batch_check-instance_method” +title=“DropboxApi::Client#copy_batch_check +(method)”>Client#copy_batch_check</a></span> to check the +job status.</p>

+ +

<p>Note: No errors are returned by this endpoint.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>entries</span>
+
+    <span class='type'>(<tt>Array&lt;Hash&gt;</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>List of entries to be moved or copied.
+ +

Each entry must be a hash with two keys: :from_path &amp; +:to_path.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">autorename</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If there&#39;s a conflict with any file,
+ +

have the Dropbox server try to autorename that file to avoid the conflict. +The default for this field is false.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Either the job id or the list of job statuses.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

25 26 27 28 29 30 31 32 33 34</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_batch.rb', line 25</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:copy_batch</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_entries'>entries</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:autorename</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:autorename</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>entries:</span> <span class='id identifier rubyid_entries'>entries</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/CopyReferenceGet_html.html b/doc/docs/DropboxApi/Endpoints/Files/CopyReferenceGet_html.html new file mode 100644 index 00000000..45663b2c --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/CopyReferenceGet_html.html @@ -0,0 +1,961 @@ + + + + + + +CopyReferenceGet.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::CopyReferenceGet
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::CopyReferenceGet";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">CopyReferenceGet</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::CopyReferenceGet
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::CopyReferenceGet</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/copy_reference_get.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/copy_reference/get</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">GetCopyReferenceResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/GetCopyReferenceError.html" title="DropboxApi::Errors::GetCopyReferenceError (class)">GetCopyReferenceError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#copy_reference_get-instance_method" title="#copy_reference_get (instance method)">#<strong>copy_reference_get</strong>(path)  &#x21d2; DropboxApi::Results::GetCopyReferenceResult </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get a copy reference to a file or folder.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="copy_reference_get-instance_method">
+
+  #<strong>copy_reference_get</strong>(path)  &#x21d2; <tt><span class='object_link'><a href="../../Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">DropboxApi::Results::GetCopyReferenceResult</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get a copy reference to a file or folder.
+ +

This reference string can be used to save that file or folder to another +user&#39;s Dropbox by passing it to <span +class='object_link'><a +href=“../../Client.html#copy_reference_save-instance_method” +title=“DropboxApi::Client#copy_reference_save +(method)”>Client#copy_reference_save</a></span>.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to the file or folder you want to get a
+ +

copy reference to.</p> </div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt><span class='object_link'><a href="../../Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">DropboxApi::Results::GetCopyReferenceResult</a></span></tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_reference_get.rb', line 16</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:copy_reference_get</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/CopyReferenceSave_html.html b/doc/docs/DropboxApi/Endpoints/Files/CopyReferenceSave_html.html new file mode 100644 index 00000000..76101deb --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/CopyReferenceSave_html.html @@ -0,0 +1,976 @@ + + + + + + +CopyReferenceSave.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::CopyReferenceSave
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::CopyReferenceSave";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">CopyReferenceSave</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::CopyReferenceSave
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::CopyReferenceSave</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/copy_reference_save.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/copy_reference/save</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/SaveCopyReferenceResult.html" title="DropboxApi::Results::SaveCopyReferenceResult (class)">SaveCopyReferenceResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/SaveCopyReferenceError.html" title="DropboxApi::Errors::SaveCopyReferenceError (class)">SaveCopyReferenceError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#copy_reference_save-instance_method" title="#copy_reference_save (instance method)">#<strong>copy_reference_save</strong>(copy_reference, path)  &#x21d2; DropboxApi::Results::SaveCopyReferenceResult </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Save a copy reference returned by <span class='object_link'><a href="../../Client.html#copy_reference_get-instance_method" title="DropboxApi::Client#copy_reference_get (method)">Client#copy_reference_get</a></span> to the user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="copy_reference_save-instance_method">
+
+  #<strong>copy_reference_save</strong>(copy_reference, path)  &#x21d2; <tt><span class='object_link'><a href="../../Results/SaveCopyReferenceResult.html" title="DropboxApi::Results::SaveCopyReferenceResult (class)">DropboxApi::Results::SaveCopyReferenceResult</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Save a copy reference returned by <span class='object_link'><a href="../../Client.html#copy_reference_get-instance_method" title="DropboxApi::Client#copy_reference_get (method)">Client#copy_reference_get</a></span> to the
+ +

user&#39;s Dropbox.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>copy_reference</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>A copy reference returned by
+ +

<span class='object_link'><a +href=“../../Client.html#copy_reference_get-instance_method” +title=“DropboxApi::Client#copy_reference_get +(method)”>Client#copy_reference_get</a></span>.</p> +</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox that is the destination.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt><span class='object_link'><a href="../../Results/SaveCopyReferenceResult.html" title="DropboxApi::Results::SaveCopyReferenceResult (class)">DropboxApi::Results::SaveCopyReferenceResult</a></span></tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18 19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_reference_save.rb', line 16</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:copy_reference_save</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_copy_reference'>copy_reference</span><span +class='comma'>,</span> <span class='id identifier +rubyid_path'>path</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>copy_reference:</span> <span class='id identifier rubyid_copy_reference'>copy_reference</span><span class='comma'>,</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/Copy_html.html b/doc/docs/DropboxApi/Endpoints/Files/Copy_html.html new file mode 100644 index 00000000..d6d5f5ed --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/Copy_html.html @@ -0,0 +1,976 @@ + + + + + + +Copy.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::Copy
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::Copy";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">Copy</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::Copy
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::Copy</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/copy.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/copy</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/RelocationError.html" title="DropboxApi::Errors::RelocationError (class)">RelocationError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#copy-instance_method" title="#copy (instance method)">#<strong>copy</strong>(from, to)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Copy a file or folder to a different location in the user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="copy-instance_method">
+
+  #<strong>copy</strong>(from, to)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Copy a file or folder to a different location in the user&#39;s Dropbox.
+ +

If the source path is a folder all its contents will be copied.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>from</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to be copied or moved.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>to</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox that is the destination.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'></span>
+
+    <div class='inline'><p>The moved file.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

15 16 17 18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy.rb', line 15</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:copy</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_from'>from</span><span +class='comma'>,</span> <span class='id identifier +rubyid_to'>to</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>from_path:</span> <span class='id identifier rubyid_from'>from</span><span class='comma'>,</span>
+  <span class='label'>to_path:</span> <span class='id identifier rubyid_to'>to</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/CreateFileRequest_html.html b/doc/docs/DropboxApi/Endpoints/Files/CreateFileRequest_html.html new file mode 100644 index 00000000..dd0de407 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/CreateFileRequest_html.html @@ -0,0 +1,961 @@ + + + + + + +CreateFileRequest.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::CreateFileRequest
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::CreateFileRequest";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">CreateFileRequest</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::CreateFileRequest
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::CreateFileRequest</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/file_requests/create_file_request.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/file_requests/create</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/FileRequest.html" title="DropboxApi::Metadata::FileRequest (class)">FileRequest</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/CreateFileRequestError.html" title="DropboxApi::Errors::CreateFileRequestError (class)">CreateFileRequestError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#create_file_request-instance_method" title="#create_file_request (instance method)">#<strong>create_file_request</strong>(title, destination)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Create a file request for a given path.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="create_file_request-instance_method">
+
+  #<strong>create_file_request</strong>(title, destination)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Create a file request for a given path.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>title</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The title of the file request. Must not be empty.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>destination</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path of the folder in the Dropbox where
+ +

uploaded files will be sent. For apps with the app folder permission, this +will be relative to the app folder.</p> </div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

15 16 17 18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/file_requests/create_file_request.rb', line 15</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:create_file_request</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_title'>title</span><span +class='comma'>,</span> <span class='id identifier +rubyid_destination'>destination</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>title:</span> <span class='id identifier rubyid_title'>title</span><span class='comma'>,</span>
+  <span class='label'>destination:</span> <span class='id identifier rubyid_destination'>destination</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/CreateFolderBatchCheck_html.html b/doc/docs/DropboxApi/Endpoints/Files/CreateFolderBatchCheck_html.html new file mode 100644 index 00000000..3beba11c --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/CreateFolderBatchCheck_html.html @@ -0,0 +1,962 @@ + + + + + + +CreateFolderBatchCheck.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::CreateFolderBatchCheck
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::CreateFolderBatchCheck";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">CreateFolderBatchCheck</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::CreateFolderBatchCheck
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::CreateFolderBatchCheck</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/create_folder_batch_check.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/create_folder_batch/check</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/CreateFolderBatchResult.html" title="DropboxApi::Results::CreateFolderBatchResult (class)">CreateFolderBatchResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/PollError.html" title="DropboxApi::Errors::PollError (class)">PollError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#create_folder_batch_check-instance_method" title="#create_folder_batch_check (instance method)">#<strong>create_folder_batch_check</strong>(async_job_id)  &#x21d2; Array </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for create_folder_batch.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="create_folder_batch_check-instance_method">
+
+  #<strong>create_folder_batch_check</strong>(async_job_id)  &#x21d2; <tt>Array</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the status of an asynchronous job for create_folder_batch.
+ +

If success, it returns list of result for each entry.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>async_job_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Id of the asynchronous job.
+ +

This is the value of a response returned from the method that launched the +job.</p> </div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>A list of one result for each entry.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder_batch_check.rb', line 16</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:create_folder_batch_check</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_async_job_id'>async_job_id</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>async_job_id:</span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/CreateFolderBatch_html.html b/doc/docs/DropboxApi/Endpoints/Files/CreateFolderBatch_html.html new file mode 100644 index 00000000..c54c57fa --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/CreateFolderBatch_html.html @@ -0,0 +1,1021 @@ + + + + + + +CreateFolderBatch.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::CreateFolderBatch
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::CreateFolderBatch";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">CreateFolderBatch</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::CreateFolderBatch
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::CreateFolderBatch</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/create_folder_batch.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/create_folder_batch</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/CreateFolderBatchResult.html" title="DropboxApi::Results::CreateFolderBatchResult (class)">CreateFolderBatchResult</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#create_folder_batch-instance_method" title="#create_folder_batch (instance method)">#<strong>create_folder_batch</strong>(paths, options = {})  &#x21d2; String, Array </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Create multiple folders at once.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="create_folder_batch-instance_method">
+
+  #<strong>create_folder_batch</strong>(paths, options = {})  &#x21d2; <tt>String</tt>, <tt>Array</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Create multiple folders at once.</p>
+ +

<p>This route is asynchronous for large batches, which returns a job +ID immediately and runs the create folder batch asynchronously. Otherwise, +creates the folders and returns the result synchronously for smaller +inputs. You can force asynchronous behaviour by using the +:force_async flag. Use <span +class='object_link'><a +href=“../../Client.html#create_folder_batch_check-instance_method” +title=“DropboxApi::Client#create_folder_batch_check +(method)”>Client#create_folder_batch_check</a></span> to +check the job status.</p>

+ +

<p>Note: No errors are returned by this endpoint.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>paths</span>
+
+    <span class='type'>(<tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>List of paths to be created in the user&#39;s Dropbox.
+ +

Duplicate path arguments in the batch are considered only once.</p> +</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">autorename</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If there&#39;s a conflict, have the
+ +

Dropbox server try to autorename the folder to avoid the conflict. The +default for this field is false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">force_async</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Whether to force the create to
+ +

happen asynchronously. The default for this field is +false.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Either the job id or the list of job statuses.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

28 29 30 31 32 33 34 35 36 37 38 39</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder_batch.rb', line 28</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:create_folder_batch</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_paths'>paths</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:autorename</span><span class='comma'>,</span>
+  <span class='symbol'>:force_async</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:autorename</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:force_async</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>paths:</span> <span class='id identifier rubyid_paths'>paths</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/CreateFolder_html.html b/doc/docs/DropboxApi/Endpoints/Files/CreateFolder_html.html new file mode 100644 index 00000000..09e2071c --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/CreateFolder_html.html @@ -0,0 +1,959 @@ + + + + + + +CreateFolder.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::CreateFolder
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::CreateFolder";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">CreateFolder</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::CreateFolder
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::CreateFolder</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/create_folder.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/create_folder</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/CreateFolderError.html" title="DropboxApi::Errors::CreateFolderError (class)">CreateFolderError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#create_folder-instance_method" title="#create_folder (instance method)">#<strong>create_folder</strong>(path)  &#x21d2; DropboxApi::Metadata::Folder </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Create a folder at a given path.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="create_folder-instance_method">
+
+  #<strong>create_folder</strong>(path)  &#x21d2; <tt><span class='object_link'><a href="../../Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">DropboxApi::Metadata::Folder</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Create a folder at a given path.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to create.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt><span class='object_link'><a href="../../Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">DropboxApi::Metadata::Folder</a></span></tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The new folder.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

13 14 15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder.rb', line 13</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:create_folder</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/DeleteBatchCheck_html.html b/doc/docs/DropboxApi/Endpoints/Files/DeleteBatchCheck_html.html new file mode 100644 index 00000000..e38d44d7 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/DeleteBatchCheck_html.html @@ -0,0 +1,961 @@ + + + + + + +DeleteBatchCheck.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::DeleteBatchCheck
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::DeleteBatchCheck";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">DeleteBatchCheck</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::DeleteBatchCheck
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::DeleteBatchCheck</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/delete_batch_check.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/delete_batch/check</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/DeleteBatchResult.html" title="DropboxApi::Results::DeleteBatchResult (class)">DeleteBatchResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/PollError.html" title="DropboxApi::Errors::PollError (class)">PollError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#delete_batch_check-instance_method" title="#delete_batch_check (instance method)">#<strong>delete_batch_check</strong>(async_job_id)  &#x21d2; :in_progress, Array </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for delete_batch.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="delete_batch_check-instance_method">
+
+  #<strong>delete_batch_check</strong>(async_job_id)  &#x21d2; <tt>:in_progress</tt>, <tt>Array</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the status of an asynchronous job for delete_batch. If success,
+ +

it returns list of result for each entry.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>async_job_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Id of the asynchronous job.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>:in_progress</tt>, <tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>This could be either the <code>:in_progress</code>
+ +

flag or a list of job statuses.</p> </div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

15 16 17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete_batch_check.rb', line 15</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:delete_batch_check</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_async_job_id'>async_job_id</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>async_job_id:</span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/DeleteBatch_html.html b/doc/docs/DropboxApi/Endpoints/Files/DeleteBatch_html.html new file mode 100644 index 00000000..1aec83c7 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/DeleteBatch_html.html @@ -0,0 +1,963 @@ + + + + + + +DeleteBatch.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::DeleteBatch
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::DeleteBatch";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">DeleteBatch</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::DeleteBatch
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::DeleteBatch</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/delete_batch.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/delete_batch</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/DeleteBatchResult.html" title="DropboxApi::Results::DeleteBatchResult (class)">DeleteBatchResult</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#delete_batch-instance_method" title="#delete_batch (instance method)">#<strong>delete_batch</strong>(entries)  &#x21d2; String, Array </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Delete multiple files/folders at once.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="delete_batch-instance_method">
+
+  #<strong>delete_batch</strong>(entries)  &#x21d2; <tt>String</tt>, <tt>Array</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Delete multiple files/folders at once.</p>
+ +

<p>This route is asynchronous, which returns a job ID immediately and +runs the delete batch asynchronously. Use <span +class='object_link'><a +href=“../../Client.html#delete_batch_check-instance_method” +title=“DropboxApi::Client#delete_batch_check +(method)”>Client#delete_batch_check</a></span> to check the +job status.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>entries</span>
+
+    <span class='type'>(<tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>List of entries, each entry is a Hash with these
+ +

fields: path (mandatory) &amp; parent_rev +(optional).</p> </div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Either the job id or the list of job statuses.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

17 18 19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete_batch.rb', line 17</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:delete_batch</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_entries'>entries</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>entries:</span> <span class='id identifier rubyid_entries'>entries</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/Delete_html.html b/doc/docs/DropboxApi/Endpoints/Files/Delete_html.html new file mode 100644 index 00000000..0998d8e4 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/Delete_html.html @@ -0,0 +1,999 @@ + + + + + + +Delete.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::Delete
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::Delete";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">Delete</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::Delete
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::Delete</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/delete.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/delete</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/DeleteError.html" title="DropboxApi::Errors::DeleteError (class)">DeleteError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(path, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Delete the file or folder at a given path.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="delete-instance_method">
+
+  #<strong>delete</strong>(path, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Delete the file or folder at a given path.</p>
+ +

<p>If the path is a folder, all its contents will be deleted +too.</p>

+ +

<p>A successful response indicates that the file or folder was +deleted. The returned metadata will be the corresponding <span +class='object_link'><a href=“../../Metadata/File.html” +title=“DropboxApi::Metadata::File +(class)”>Metadata::File</a></span> or <span +class='object_link'><a href=“../../Metadata/Folder.html” +title=“DropboxApi::Metadata::Folder +(class)”>Metadata::Folder</a></span> for the item at time of +deletion, and not a <span class='object_link'><a +href=“../../Metadata/Deleted.html” title=“DropboxApi::Metadata::Deleted +(class)”>Metadata::Deleted</a></span> object.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to delete.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">parent_rev</span>
+      <span class="type">(<tt>String</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Perform delete if given &quot;rev&quot;
+ +

matches the existing file&#39;s latest &quot;rev&quot;. This +field does not support deleting a folder. If the given +&quot;rev&quot; doesn&#39;t match, a <span +class='object_link'><a +href=“../../Errors/FileConflictError.html” +title=“DropboxApi::Errors::FileConflictError +(class)”>DropboxApi::Errors::FileConflictError</a></span> +will be raised.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

25 26 27 28 29 30 31</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete.rb', line 25</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:delete</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:parent_rev</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/Download_html.html b/doc/docs/DropboxApi/Endpoints/Files/Download_html.html new file mode 100644 index 00000000..5b6ec36c --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/Download_html.html @@ -0,0 +1,945 @@ + + + + + + +Download.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::Download
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::Download";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">Download</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::Download
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../ContentDownload.html" title="DropboxApi::Endpoints::ContentDownload (class)">ContentDownload</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../ContentDownload.html" title="DropboxApi::Endpoints::ContentDownload (class)">ContentDownload</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::Download</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/download.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/download</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/DownloadError.html" title="DropboxApi::Errors::DownloadError (class)">DownloadError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#download-instance_method" title="#download (instance method)">#<strong>download</strong>(path, &amp;block)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Download a file from a user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../ContentDownload.html" title="DropboxApi::Endpoints::ContentDownload (class)">ContentDownload</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../ContentDownload.html#build_connection-instance_method" title="DropboxApi::Endpoints::ContentDownload#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../ContentDownload.html#build_request-instance_method" title="DropboxApi::Endpoints::ContentDownload#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../ContentDownload.html#perform_request-instance_method" title="DropboxApi::Endpoints::ContentDownload#perform_request (method)">#perform_request</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="download-instance_method">
+
+  #<strong>download</strong>(path, &amp;block)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Download a file from a user&#39;s Dropbox.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path of the file to download.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/download.rb', line 12</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:download</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span +class='op'>&amp;</span><span class='id +identifier rubyid_block'>block</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/GetMetadata_html.html b/doc/docs/DropboxApi/Endpoints/Files/GetMetadata_html.html new file mode 100644 index 00000000..85316c1d --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/GetMetadata_html.html @@ -0,0 +1,1023 @@ + + + + + + +GetMetadata.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::GetMetadata
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::GetMetadata";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">GetMetadata</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::GetMetadata
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::GetMetadata</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/get_metadata.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/get_metadata</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/GetMetadataError.html" title="DropboxApi::Errors::GetMetadataError (class)">GetMetadataError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_metadata-instance_method" title="#get_metadata (instance method)">#<strong>get_metadata</strong>(path, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the metadata for a file or folder.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="get_metadata-instance_method">
+
+  #<strong>get_metadata</strong>(path, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the metadata for a file or folder.</p>
+ +

<p>Note: Metadata for the root folder is unsupported.</p>

+ +

<p>If you request the media_info attribute, note that it +could be set to :pending or nil.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path of a file or folder on Dropbox.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">include_media_info</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If <code>true</code>, <code>media_info</code>
+ +

is set for photo and video. The default for this field is +false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">include_has_explicit_shared_members</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>,
+ +

the results will include a flag for each file indicating whether or not +that file has any explicit members. The default for this field is +false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">include_deleted</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>,
+ +

<span class='object_link'><a +href=“../../Metadata/Deleted.html” title=“DropboxApi::Metadata::Deleted +(class)”>Metadata::Deleted</a></span> will be returned for +deleted file or folder, otherwise <span +class='object_link'><a href=“../../Errors/NotFoundError.html” +title=“DropboxApi::Errors::NotFoundError +(class)”>DropboxApi::Errors::NotFoundError</a></span> will +be raised. The default for this field is false.</p> +</div>

+ +
    </li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

30 31 32 33 34 35 36 37 38 39 40</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_metadata.rb', line 30</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_metadata</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:include_media_info</span><span class='comma'>,</span>
+  <span class='symbol'>:include_deleted</span><span class='comma'>,</span>
+  <span class='symbol'>:include_has_explicit_shared_members</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/GetPreview_html.html b/doc/docs/DropboxApi/Endpoints/Files/GetPreview_html.html new file mode 100644 index 00000000..38e30a03 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/GetPreview_html.html @@ -0,0 +1,948 @@ + + + + + + +GetPreview.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::GetPreview
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::GetPreview";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">GetPreview</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::GetPreview
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../ContentDownload.html" title="DropboxApi::Endpoints::ContentDownload (class)">ContentDownload</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../ContentDownload.html" title="DropboxApi::Endpoints::ContentDownload (class)">ContentDownload</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::GetPreview</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/get_preview.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/get_preview</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/PreviewError.html" title="DropboxApi::Errors::PreviewError (class)">PreviewError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_preview-instance_method" title="#get_preview (instance method)">#<strong>get_preview</strong>(path, &amp;block)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get a preview for a file.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../ContentDownload.html" title="DropboxApi::Endpoints::ContentDownload (class)">ContentDownload</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../ContentDownload.html#build_connection-instance_method" title="DropboxApi::Endpoints::ContentDownload#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../ContentDownload.html#build_request-instance_method" title="DropboxApi::Endpoints::ContentDownload#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../ContentDownload.html#perform_request-instance_method" title="DropboxApi::Endpoints::ContentDownload#perform_request (method)">#perform_request</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="get_preview-instance_method">
+
+  #<strong>get_preview</strong>(path, &amp;block)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get a preview for a file. Currently previews are only generated for the
+ +

files with the following extensions: .doc, .docx, .docm, .ppt, .pps, .ppsx, +.ppsm, .pptx, .pptm, .xls, .xlsx, .xlsm, .rtf</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path of the file to preview.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_preview.rb', line 14</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_preview</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span +class='op'>&amp;</span><span class='id +identifier rubyid_block'>block</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/GetTemporaryLink_html.html b/doc/docs/DropboxApi/Endpoints/Files/GetTemporaryLink_html.html new file mode 100644 index 00000000..377a78c9 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/GetTemporaryLink_html.html @@ -0,0 +1,945 @@ + + + + + + +GetTemporaryLink.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::GetTemporaryLink
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::GetTemporaryLink";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">GetTemporaryLink</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::GetTemporaryLink
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::GetTemporaryLink</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/get_temporary_link.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/get_temporary_link</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/GetTemporaryLinkResult.html" title="DropboxApi::Results::GetTemporaryLinkResult (class)">GetTemporaryLinkResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/GetMetadataError.html" title="DropboxApi::Errors::GetMetadataError (class)">GetMetadataError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_temporary_link-instance_method" title="#get_temporary_link (instance method)">#<strong>get_temporary_link</strong>(path)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get a temporary link to stream content of a file.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="get_temporary_link-instance_method">
+
+  #<strong>get_temporary_link</strong>(path)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get a temporary link to stream content of a file. This link will expire
+ +

in four hours and afterwards you will get 410 Gone. Content-Type of the +link is determined automatically by the file&#39;s mime type.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to the file you want a temporary link to.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_temporary_link.rb', line 14</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_temporary_link</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch_html.html b/doc/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch_html.html new file mode 100644 index 00000000..f0df07a9 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch_html.html @@ -0,0 +1,1060 @@ + + + + + + +GetThumbnailBatch.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::GetThumbnailBatch
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::GetThumbnailBatch";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">GetThumbnailBatch</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::GetThumbnailBatch
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../RpcContent.html" title="DropboxApi::Endpoints::RpcContent (class)">RpcContent</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../RpcContent.html" title="DropboxApi::Endpoints::RpcContent (class)">RpcContent</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::GetThumbnailBatch</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/get_thumbnail_batch</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/GetThumbnailBatchResult.html" title="DropboxApi::Results::GetThumbnailBatchResult (class)">GetThumbnailBatchResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/ThumbnailBatchError.html" title="DropboxApi::Errors::ThumbnailBatchError (class)">ThumbnailBatchError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_entries_params-instance_method" title="#build_entries_params (instance method)">#<strong>build_entries_params</strong>(paths, options)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_thumbnail_batch-instance_method" title="#get_thumbnail_batch (instance method)">#<strong>get_thumbnail_batch</strong>(paths, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get a thumbnails for a batch of images.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../RpcContent.html" title="DropboxApi::Endpoints::RpcContent (class)">RpcContent</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../RpcContent.html#build_connection-instance_method" title="DropboxApi::Endpoints::RpcContent#build_connection (method)">#build_connection</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build_entries_params-instance_method">
+
+  #<strong>build_entries_params</strong>(paths, options)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

32 33 34 35 36</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb', line 32</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_build_entries_params'>build_entries_params</span><span +class='lparen'>(</span><span class='id identifier +rubyid_paths'>paths</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='op'>|</span>
+  <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="get_thumbnail_batch-instance_method">
+
+  #<strong>get_thumbnail_batch</strong>(paths, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get a thumbnails for a batch of images.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>paths</span>
+
+    <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The paths to the image files you want thumbnails for.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">format</span>
+      <span class="type">(<tt>:jpeg</tt>, <tt>:png</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The format for the thumbnail image,
+ +

:jpeg (default) or :png. For images that are +photos, :jpeg should be preferred, while png is better for +screenshots and digital arts. The default is :jpeg.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">size</span>
+  <span class="type">(<tt>:w32h32</tt>, <tt>:w64h64</tt>, <tt>:w128h128</tt>, <tt>:w640h480</tt>, <tt>:w1024h768</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>The size for the thumbnail image. The default is <code>:w64h64</code>.</p>
+ +

</div>

+ +
</li>
+
+<li>
+  <span class="name">mode</span>
+  <span class="type">(<tt>:strict</tt>, <tt>:bestfit</tt>, <tt>:fitone_bestfit</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>How to resize and crop the image to achieve the desired size. The default
+ +

for this union is strict.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

23 24 25 26 27 28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb', line 23</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_thumbnail_batch</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_paths'>paths</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='comma'>,</span> <span class='symbol'>:size</span><span class='comma'>,</span> <span class='symbol'>:mode</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:jpeg</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:size</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:w64h64</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:mode</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:strict</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>entries:</span> <span class='id identifier rubyid_build_entries_params'>build_entries_params</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/GetThumbnail_html.html b/doc/docs/DropboxApi/Endpoints/Files/GetThumbnail_html.html new file mode 100644 index 00000000..96087802 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/GetThumbnail_html.html @@ -0,0 +1,1175 @@ + + + + + + +GetThumbnail.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::GetThumbnail
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::GetThumbnail";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">GetThumbnail</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::GetThumbnail
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../ContentDownload.html" title="DropboxApi::Endpoints::ContentDownload (class)">ContentDownload</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../ContentDownload.html" title="DropboxApi::Endpoints::ContentDownload (class)">ContentDownload</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::GetThumbnail</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/get_thumbnail.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/get_thumbnail</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/PreviewError.html" title="DropboxApi::Errors::PreviewError (class)">PreviewError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_thumbnail-instance_method" title="#get_thumbnail (instance method)">#<strong>get_thumbnail</strong>(path, options = {}, &amp;block)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get a thumbnail for an image.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../ContentDownload.html" title="DropboxApi::Endpoints::ContentDownload (class)">ContentDownload</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../ContentDownload.html#build_connection-instance_method" title="DropboxApi::Endpoints::ContentDownload#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../ContentDownload.html#build_request-instance_method" title="DropboxApi::Endpoints::ContentDownload#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../ContentDownload.html#perform_request-instance_method" title="DropboxApi::Endpoints::ContentDownload#perform_request (method)">#perform_request</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="get_thumbnail-instance_method">
+
+  #<strong>get_thumbnail</strong>(path, options = {}, &amp;block)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get a thumbnail for an image.</p>
+ +

<p>This method currently supports files with the following file +extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger +than 20MB in size won&#39;t be converted to a thumbnail.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+    <pre class="example code"><code><span class='comment'># Save thumbnail to a local file
+ +

</span><span class='id identifier +rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“../../../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“../../Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“../../Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span> <span class='id +identifier rubyid_file'>file</span> <span +class='op'>=</span> <span +class='const'>File</span><span +class='period'>.</span><span class='id identifier +rubyid_open'>open</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>thumbnail.png</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>w</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_thumbnail'>get_thumbnail</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/dropbox_image.png</span><span +class='tstring_end'>&quot;</span></span> +<span class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_thumbnail_content'>thumbnail_content</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_thumbnail_content'>thumbnail_content</span>
+ +

<span class='kw'>end</span> <span class='id +identifier rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_close'>close</span></code></pre>

+ +
<pre class="example code"><code><span class='comment'># Save thumbnail to a local file with .jpg format
+ +

</span><span class='id identifier +rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“../../../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“../../Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“../../Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span> <span class='id +identifier rubyid_file'>file</span> <span +class='op'>=</span> <span +class='const'>File</span><span +class='period'>.</span><span class='id identifier +rubyid_open'>open</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>thumbnail.jpg</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>w</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_thumbnail'>get_thumbnail</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/dropbox_image.png</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='symbol'>:format</span> <span +class='op'>=&gt;</span> <span +class='symbol'>:jpeg</span><span +class='rparen'>)</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_thumbnail_content'>thumbnail_content</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_file'>file</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_thumbnail_content'>thumbnail_content</span>
+ +

<span class='kw'>end</span> <span class='id +identifier rubyid_file'>file</span><span +class='period'>.</span><span class='id identifier +rubyid_close'>close</span></code></pre>

+ +
<pre class="example code"><code><span class='comment'># Upload thumbnail to Amazon S3 (assuming you&#39;re using their SDK)
+ +

</span><span class='id identifier +rubyid_s3_object'>s3_object</span> <span +class='op'>=</span> <span +class='const'>AWS</span><span +class='op'>::</span><span +class='const'>S3</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='period'>.</span><span class='id identifier +rubyid_s3'>s3</span><span +class='period'>.</span><span class='id identifier +rubyid_buckets'>buckets</span><span +class='lbracket'>[</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>my-bucket</span><span +class='tstring_end'>&#39;</span></span><span +class='rbracket'>]</span><span +class='period'>.</span><span class='id identifier +rubyid_objects'>objects</span><span +class='lbracket'>[</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>key</span><span +class='tstring_end'>&#39;</span></span><span +class='rbracket'>]</span> <span +class='comment'>#=&gt; &lt;AWS::S3::S3Object …&gt; +</span><span class='id identifier +rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“../../../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“../../Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“../../Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span> <span class='id +identifier rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_thumbnail'>get_thumbnail</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/dropbox_image.png</span><span +class='tstring_end'>&quot;</span></span> +<span class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_thumbnail_content'>thumbnail_content</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_s3_object'>s3_object</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='id identifier rubyid_thumbnail_content'>thumbnail_content</span>
+ +

<span class='kw'>end</span></code></pre>

+ +
</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to the image file you want to thumbnail.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">format</span>
+      <span class="type">(<tt>:jpeg</tt>, <tt>:png</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The format for the thumbnail image,
+ +

:jpeg (default) or :png. For images that are +photos, :jpeg should be preferred, while png is better for +screenshots and digital arts. The default is :jpeg.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">size</span>
+  <span class="type">(<tt>:w32h32</tt>, <tt>:w64h64</tt>, <tt>:w128h128</tt>, <tt>:w640h480</tt>, <tt>:w1024h768</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>The size for the thumbnail image. The default is <code>:w64h64</code>.</p>
+ +

</div>

+ +
    </li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

48 49 50 51 52 53 54 55 56</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/get_thumbnail.rb', line 48</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_thumbnail</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='comma'>,</span> <span +class='op'>&amp;</span><span class='id +identifier rubyid_block'>block</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='comma'>,</span> <span class='symbol'>:size</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:jpeg</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:size</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:w64h64</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/ListFolderContinue_html.html b/doc/docs/DropboxApi/Endpoints/Files/ListFolderContinue_html.html new file mode 100644 index 00000000..786bc3f5 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/ListFolderContinue_html.html @@ -0,0 +1,955 @@ + + + + + + +ListFolderContinue.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::ListFolderContinue
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::ListFolderContinue";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">ListFolderContinue</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::ListFolderContinue
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::ListFolderContinue</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/list_folder_continue.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+        <div class="docstring">
+<div class="discussion">
+  <p>NOTE: This hasn&#39;t been tested with real data, I couldn&#39;t make a query
+    long enough to enable the <code>has_more</code> attribute in the
+    <code>ListFolderResult</code>.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/list_folder/continue</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/ListFolderResult.html" title="DropboxApi::Results::ListFolderResult (class)">ListFolderResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/ListFolderContinueError.html" title="DropboxApi::Errors::ListFolderContinueError (class)">ListFolderContinueError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_folder_continue-instance_method" title="#list_folder_continue (instance method)">#<strong>list_folder_continue</strong>(cursor)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Once a cursor has been retrieved from <code>list_folder</code>, use this to paginate through all files and retrieve updates to the folder.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="list_folder_continue-instance_method">
+
+  #<strong>list_folder_continue</strong>(cursor)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Once a cursor has been retrieved from <code>list_folder</code>, use this to paginate
+ +

through all files and retrieve updates to the folder.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>cursor</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The cursor returned by your last call to
+ +

list_folder or list_folder_continue.</p> </div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder_continue.rb', line 17</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_folder_continue</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor_html.html b/doc/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor_html.html new file mode 100644 index 00000000..d249c902 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor_html.html @@ -0,0 +1,1021 @@ + + + + + + +ListFolderGetLatestCursor.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::ListFolderGetLatestCursor
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::ListFolderGetLatestCursor";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">ListFolderGetLatestCursor</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::ListFolderGetLatestCursor
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::ListFolderGetLatestCursor</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/list_folder/get_latest_cursor</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/ListFolderGetLatestCursorResult.html" title="DropboxApi::Results::ListFolderGetLatestCursorResult (class)">ListFolderGetLatestCursorResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/ListFolderError.html" title="DropboxApi::Errors::ListFolderError (class)">ListFolderError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_folder_get_latest_cursor-instance_method" title="#list_folder_get_latest_cursor (instance method)">#<strong>list_folder_get_latest_cursor</strong>(options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>A way to quickly get a cursor for the folder&#39;s state.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="list_folder_get_latest_cursor-instance_method">
+
+  #<strong>list_folder_get_latest_cursor</strong>(options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>A way to quickly get a cursor for the folder&#39;s state. Unlike
+ +

<span class='object_link'><a +href=“../../Client.html#list_folder-instance_method” +title=“DropboxApi::Client#list_folder +(method)”>Client#list_folder</a></span>, this +doesn&#39;t return any entries. This endpoint is for app which only +needs to know about new files and modifications and doesn&#39;t need to +know about files that already exist in Dropbox.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">path</span>
+      <span class="type">(<tt>String</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The path to the folder you want to read.</p>
+ +

</div>

+ +
</li>
+
+<li>
+  <span class="name">recursive</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>, the list folder operation
+ +

will be applied recursively to all subfolders and the response will contain +contents of all subfolders. The default for this field is +false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">include_media_info</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>, <code>media_info</code> is
+ +

set for photo and video. The default for this field is +false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">include_deleted</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>,
+ +

<span class='object_link'><a +href=“../../Metadata/Deleted.html” title=“DropboxApi::Metadata::Deleted +(class)”>Metadata::Deleted</a></span> will be returned for +deleted file or folder, otherwise <span +class='object_link'><a href=“../../Errors/LookupError.html” +title=“DropboxApi::Errors::LookupError +(class)”>DropboxApi::Errors::LookupError</a></span> will be +returned. The default for this field is false.</p> +</div>

+ +
    </li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

28 29 30 31 32 33 34 35 36 37 38 39 40 41</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb', line 28</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_folder_get_latest_cursor</span> +<span class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:path</span><span class='comma'>,</span>
+  <span class='symbol'>:recursive</span><span class='comma'>,</span>
+  <span class='symbol'>:include_media_info</span><span class='comma'>,</span>
+  <span class='symbol'>:include_deleted</span><span class='comma'>,</span>
+  <span class='symbol'>:include_has_explicit_shared_members</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:recursive</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_media_info</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_deleted</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll_html.html b/doc/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll_html.html new file mode 100644 index 00000000..c08f1d2c --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll_html.html @@ -0,0 +1,994 @@ + + + + + + +ListFolderLongpoll.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::ListFolderLongpoll
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::ListFolderLongpoll";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">ListFolderLongpoll</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::ListFolderLongpoll
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../RpcNotify.html" title="DropboxApi::Endpoints::RpcNotify (class)">RpcNotify</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../RpcNotify.html" title="DropboxApi::Endpoints::RpcNotify (class)">RpcNotify</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::ListFolderLongpoll</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/list_folder_longpoll.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/list_folder/longpoll</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/ListFolderLongpollResult.html" title="DropboxApi::Results::ListFolderLongpollResult (class)">ListFolderLongpollResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/ListFolderLongpollError.html" title="DropboxApi::Errors::ListFolderLongpollError (class)">ListFolderLongpollError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_folder_longpoll-instance_method" title="#list_folder_longpoll (instance method)">#<strong>list_folder_longpoll</strong>(cursor, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>A longpoll endpoint to wait for changes on an account.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../RpcNotify.html" title="DropboxApi::Endpoints::RpcNotify (class)">RpcNotify</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../RpcNotify.html#build_connection-instance_method" title="DropboxApi::Endpoints::RpcNotify#build_connection (method)">#build_connection</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="list_folder_longpoll-instance_method">
+
+  #<strong>list_folder_longpoll</strong>(cursor, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>A longpoll endpoint to wait for changes on an account. In conjunction
+ +

with list_folder, this call gives you a low-latency way to monitor an +account for file changes. The connection will block until there are changes +available or a timeout occurs. This endpoint is useful mostly for +client-side apps. If you&#39;re looking for server-side notifications, +check out our webhooks documentation.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>cursor</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>A cursor as returned by list_folder or
+ +

list_folder_continue.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">timeout</span>
+      <span class="type">(<tt>Numeric</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>A timeout in seconds. The request will
+ +

block for at most this length of time, plus up to 90 seconds of random +jitter added to avoid the thundering herd problem. Care should be taken +when using this parameter, as some network infrastructure does not support +long timeouts. The default for this field is 30.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

25 26 27 28 29 30 31 32 33 34</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder_longpoll.rb', line 25</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_folder_longpoll</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:timeout</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:timeout</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>30</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/ListFolder_html.html b/doc/docs/DropboxApi/Endpoints/Files/ListFolder_html.html new file mode 100644 index 00000000..0d94bdf4 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/ListFolder_html.html @@ -0,0 +1,1043 @@ + + + + + + +ListFolder.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::ListFolder
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::ListFolder";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">ListFolder</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::ListFolder
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::ListFolder</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/list_folder.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/list_folder</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/ListFolderResult.html" title="DropboxApi::Results::ListFolderResult (class)">ListFolderResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/ListFolderError.html" title="DropboxApi::Errors::ListFolderError (class)">ListFolderError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_folder-instance_method" title="#list_folder (instance method)">#<strong>list_folder</strong>(path, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the contents of a folder.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="list_folder-instance_method">
+
+  #<strong>list_folder</strong>(path, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the contents of a folder.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to the folder you want to read.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">recursive</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If <code>true</code>, the list folder operation
+ +

will be applied recursively to all subfolders and the response will contain +contents of all subfolders. The default for this field is +false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">include_media_info</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>, media_info
+ +

is set for photo and video. The default for this field is +false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">include_deleted</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If <code>true</code>,
+ +

<span class='object_link'><a +href=“../../Metadata/Deleted.html” title=“DropboxApi::Metadata::Deleted +(class)”>Metadata::Deleted</a></span> will be returned for +deleted file or folder, otherwise <span +class='object_link'><a href=“../../Errors/NotFoundError.html” +title=“DropboxApi::Errors::NotFoundError +(class)”>DropboxApi::Errors::NotFoundError</a></span> will +be raised. The default for this field is false.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">limit</span>
+  <span class="type">(<tt>Numeric</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If present, will specify max number of
+ +

results per request (Note: <a href=“www.dropbox.com/developers/documentation/http/documentation#files-list_folder” +target=“_parent” title=“Dropbox docs”>Dropbox docs</a> indicate +this is &quot;approximate&quot;, and more may be +returned)</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder.rb', line 29</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_folder</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:recursive</span><span class='comma'>,</span>
+  <span class='symbol'>:include_media_info</span><span class='comma'>,</span>
+  <span class='symbol'>:include_deleted</span><span class='comma'>,</span>
+  <span class='symbol'>:shared_link</span><span class='comma'>,</span>
+  <span class='symbol'>:include_has_explicit_shared_members</span><span class='comma'>,</span>
+  <span class='symbol'>:limit</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:recursive</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_media_info</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_deleted</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_build_shared_link_param'>build_shared_link_param</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/ListRevisions_html.html b/doc/docs/DropboxApi/Endpoints/Files/ListRevisions_html.html new file mode 100644 index 00000000..7f259f53 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/ListRevisions_html.html @@ -0,0 +1,980 @@ + + + + + + +ListRevisions.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::ListRevisions
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::ListRevisions";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">ListRevisions</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::ListRevisions
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::ListRevisions</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/list_revisions.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/list_revisions</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/ListRevisionsResult.html" title="DropboxApi::Results::ListRevisionsResult (class)">ListRevisionsResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/ListRevisionsError.html" title="DropboxApi::Errors::ListRevisionsError (class)">ListRevisionsError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_revisions-instance_method" title="#list_revisions (instance method)">#<strong>list_revisions</strong>(path, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Return revisions of a file.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="list_revisions-instance_method">
+
+  #<strong>list_revisions</strong>(path, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Return revisions of a file</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to file you want to see the revisions of.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">limit</span>
+      <span class="type">(<tt>Numeric</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The maximum number of revision entries
+ +

returned. The default for this field is 10.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18 19 20 21 22 23 24 25</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_revisions.rb', line 16</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_revisions</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:limit</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>10</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/Move_html.html b/doc/docs/DropboxApi/Endpoints/Files/Move_html.html new file mode 100644 index 00000000..ebd25805 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/Move_html.html @@ -0,0 +1,1008 @@ + + + + + + +Move.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::Move
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::Move";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">Move</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::Move
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::Move</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/move.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/move</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/RelocationError.html" title="DropboxApi::Errors::RelocationError (class)">RelocationError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#move-instance_method" title="#move (instance method)">#<strong>move</strong>(from, to, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Move a file or folder to a different location in the user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="move-instance_method">
+
+  #<strong>move</strong>(from, to, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Move a file or folder to a different location in the user&#39;s Dropbox.</p>
+ +

<p>If the source path is a folder all its contents will be +moved.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>from</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to be copied or moved.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>to</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox that is the destination.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">autorename</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If there&#39;s a conflict, have the
+ +

Dropbox server try to autorename the file to avoid the conflict. The +default for this field is false.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

20 21 22 23 24 25 26 27 28 29 30 31 32</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/move.rb', line 20</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:move</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_from'>from</span><span +class='comma'>,</span> <span class='id identifier +rubyid_to'>to</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='comment'># We&#39;re not implementing support for the `allow_shared_folder` option
+ +

</span> <span class='comment'># because according to +Dropbox&#39;s documentation: &quot;This field is always +</span> <span class='comment'># true for +move&quot;. </span> <span class='id identifier +rubyid_validate_options'>validate_options</span><span +class='lparen'>(</span><span +class='lbracket'>[</span>

+ +
  <span class='symbol'>:autorename</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>from_path:</span> <span class='id identifier rubyid_from'>from</span><span class='comma'>,</span>
+  <span class='label'>to_path:</span> <span class='id identifier rubyid_to'>to</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/PermanentlyDelete_html.html b/doc/docs/DropboxApi/Endpoints/Files/PermanentlyDelete_html.html new file mode 100644 index 00000000..21e3da07 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/PermanentlyDelete_html.html @@ -0,0 +1,984 @@ + + + + + + +PermanentlyDelete.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::PermanentlyDelete
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::PermanentlyDelete";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (P)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">PermanentlyDelete</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::PermanentlyDelete
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::PermanentlyDelete</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/permanently_delete.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/permanently_delete</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/VoidResult.html" title="DropboxApi::Results::VoidResult (class)">VoidResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/DeleteError.html" title="DropboxApi::Errors::DeleteError (class)">DeleteError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#permanently_delete-instance_method" title="#permanently_delete (instance method)">#<strong>permanently_delete</strong>(path, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Permanently delete the file or folder at a given path.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="permanently_delete-instance_method">
+
+  #<strong>permanently_delete</strong>(path, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Permanently delete the file or folder at a given path.</p>
+ +

<p>See <a href=“https://www.dropbox.com/en/help/40www.dropbox.com/en/help/40”>https://www.dropbox.com/en/help/40>

+ +

<p>Note: This endpoint is only available for Dropbox Business +apps.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to delete.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">parent_rev</span>
+      <span class="type">(<tt>String</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Perform delete if given &quot;rev&quot;
+ +

matches the existing file&#39;s latest &quot;rev&quot;. This +field does not support deleting a folder.</p> </div>

+ +
    </li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

21 22 23 24 25 26 27</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/permanently_delete.rb', line 21</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:permanently_delete</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:parent_rev</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/Restore_html.html b/doc/docs/DropboxApi/Endpoints/Files/Restore_html.html new file mode 100644 index 00000000..0ac9cb2c --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/Restore_html.html @@ -0,0 +1,960 @@ + + + + + + +Restore.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::Restore
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::Restore";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">Restore</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::Restore
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::Restore</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/restore.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/restore</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/RestoreError.html" title="DropboxApi::Errors::RestoreError (class)">RestoreError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#restore-instance_method" title="#restore (instance method)">#<strong>restore</strong>(path, rev)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Restore a file to a specific revision.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="restore-instance_method">
+
+  #<strong>restore</strong>(path, rev)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Restore a file to a specific revision</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to the file you want to restore.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>rev</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The revision to restore for the file.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

13 14 15 16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/restore.rb', line 13</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:restore</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_rev'>rev</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
+  <span class='label'>rev:</span> <span class='id identifier rubyid_rev'>rev</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus_html.html b/doc/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus_html.html new file mode 100644 index 00000000..2e2485c4 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus_html.html @@ -0,0 +1,959 @@ + + + + + + +SaveUrlCheckJobStatus.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">SaveUrlCheckJobStatus</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/save_url_check_job_status.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/save_url/check_job_status</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/SaveUrlJobStatus.html" title="DropboxApi::Results::SaveUrlJobStatus (class)">SaveUrlJobStatus</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/PollError.html" title="DropboxApi::Errors::PollError (class)">PollError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#save_url_check_job_status-instance_method" title="#save_url_check_job_status (instance method)">#<strong>save_url_check_job_status</strong>(job_id)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Check the status of a <code>save_url</code> job.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="save_url_check_job_status-instance_method">
+
+  #<strong>save_url_check_job_status</strong>(job_id)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Check the status of a <code>save_url</code> job.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>job_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Id of the asynchronous job. This is the value of
+ +

a response returned from the method that launched the job.</p> +</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'></span>
+
+    <div class='inline'><p>The current status of the job.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

14 15 16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/save_url_check_job_status.rb', line 14</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:save_url_check_job_status</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_job_id'>job_id</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>async_job_id:</span> <span class='id identifier rubyid_job_id'>job_id</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/SaveUrl_html.html b/doc/docs/DropboxApi/Endpoints/Files/SaveUrl_html.html new file mode 100644 index 00000000..7dbdb0b8 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/SaveUrl_html.html @@ -0,0 +1,977 @@ + + + + + + +SaveUrl.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::SaveUrl
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::SaveUrl";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">SaveUrl</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::SaveUrl
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::SaveUrl</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/save_url.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/save_url</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/SaveUrlResult.html" title="DropboxApi::Results::SaveUrlResult (class)">SaveUrlResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/SaveUrlError.html" title="DropboxApi::Errors::SaveUrlError (class)">SaveUrlError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#save_url-instance_method" title="#save_url (instance method)">#<strong>save_url</strong>(path, url)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Save a specified URL into a file in user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="save_url-instance_method">
+
+  #<strong>save_url</strong>(path, url)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Save a specified URL into a file in user&#39;s Dropbox. If the given path
+ +

already exists, the file will be renamed to avoid the conflict (e.g. myfile +(1).txt).</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path in Dropbox where the URL will be saved to.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>url</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The URL to be saved.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'></span>
+
+    <div class='inline'><p>Either the saved file or a reference to the async job.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18 19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/save_url.rb', line 16</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:save_url</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_url'>url</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
+  <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/SearchContinue_html.html b/doc/docs/DropboxApi/Endpoints/Files/SearchContinue_html.html new file mode 100644 index 00000000..83a94537 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/SearchContinue_html.html @@ -0,0 +1,950 @@ + + + + + + +SearchContinue.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::SearchContinue
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::SearchContinue";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">SearchContinue</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::SearchContinue
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::SearchContinue</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/search_continue.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/search/continue_v2</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/SearchV2Result.html" title="DropboxApi::Results::SearchV2Result (class)">SearchV2Result</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/SearchError.html" title="DropboxApi::Errors::SearchError (class)">SearchError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#search_continue-instance_method" title="#search_continue (instance method)">#<strong>search_continue</strong>(cursor)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>search:2.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="search_continue-instance_method">
+
+  #<strong>search_continue</strong>(cursor)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>search:2. Used to fetch the next page of results.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>cursor</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The cursor returned by your last call to</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/search_continue.rb', line 19</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:search_continue</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/Search_html.html b/doc/docs/DropboxApi/Endpoints/Files/Search_html.html new file mode 100644 index 00000000..25f22da4 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/Search_html.html @@ -0,0 +1,997 @@ + + + + + + +Search.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::Search
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::Search";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">Search</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::Search
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::Search</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/search.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/search_v2</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/SearchV2Result.html" title="DropboxApi::Results::SearchV2Result (class)">SearchV2Result</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/SearchError.html" title="DropboxApi::Errors::SearchError (class)">SearchError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#search-instance_method" title="#search (instance method)">#<strong>search</strong>(query, options = nil, match_field_options = nil)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Searches for files and folders.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="search-instance_method">
+
+  #<strong>search</strong>(query, options = nil, match_field_options = nil)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Searches for files and folders.</p>
+ +

<p>Note: Recent changes may not immediately be reflected in search +results due to a short delay in indexing.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>query</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The string to search for. May match across
+ +

multiple fields based on the request arguments.</p> </div>

+ +
</li>
+
+<li>
+
+    <span class='name'>options</span>
+
+    <span class='type'>(<tt><span class='object_link'><a href="../../Metadata/SearchOptions.html" title="DropboxApi::Metadata::SearchOptions (class)">DropboxApi::Metadata::SearchOptions</a></span></tt>)</span>
+
+    <em class="default">(defaults to: <tt>nil</tt>)</em>
+
+    &mdash;
+    <div class='inline'><p>Options for more
+ +

targeted search results. This field is optional.</p> </div>

+ +
</li>
+
+<li>
+
+    <span class='name'>match_field_options</span>
+
+    <span class='type'>(<tt><span class='object_link'><a href="../../Metadata/SearchMatchFieldOptions.html" title="DropboxApi::Metadata::SearchMatchFieldOptions (class)">DropboxApi::Metadata::SearchMatchFieldOptions</a></span></tt>)</span>
+
+    <em class="default">(defaults to: <tt>nil</tt>)</em>
+
+    &mdash;
+    <div class='inline'><p>Options for search results match fields. This field is optional.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

22 23 24 25 26 27 28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/search.rb', line 22</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:search</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_query'>query</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='kw'>nil</span><span +class='comma'>,</span> <span class='id identifier +rubyid_match_field_options'>match_field_options</span> +<span class='op'>=</span> <span +class='kw'>nil</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span> <span class='rbrace'>}</span>
+
+<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:options</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span> <span class='kw'>unless</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+
+<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:match_field_options</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match_field_options'>match_field_options</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span> <span class='kw'>unless</span> <span class='id identifier rubyid_match_field_options'>match_field_options</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2_html.html b/doc/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2_html.html new file mode 100644 index 00000000..a57262bb --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2_html.html @@ -0,0 +1,1024 @@ + + + + + + +UploadSessionAppendV2.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::UploadSessionAppendV2
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::UploadSessionAppendV2";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">UploadSessionAppendV2</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::UploadSessionAppendV2
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::UploadSessionAppendV2</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/upload_session_append_v2.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/upload_session/append_v2</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/VoidResult.html" title="DropboxApi::Results::VoidResult (class)">VoidResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/UploadSessionLookupError.html" title="DropboxApi::Errors::UploadSessionLookupError (class)">UploadSessionLookupError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#upload_session_append_v2-instance_method" title="#upload_session_append_v2 (instance method)">#<strong>upload_session_append_v2</strong>(cursor, content, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Append more data to an upload session.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../ContentUpload.html#build_connection-instance_method" title="DropboxApi::Endpoints::ContentUpload#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../ContentUpload.html#build_request-instance_method" title="DropboxApi::Endpoints::ContentUpload#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../ContentUpload.html#perform_request-instance_method" title="DropboxApi::Endpoints::ContentUpload#perform_request (method)">#perform_request</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="upload_session_append_v2-instance_method">
+
+  #<strong>upload_session_append_v2</strong>(cursor, content, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Append more data to an upload session.</p>
+ +

<p>When the parameter close is set, this call will close +the session.</p>

+ +

<p>A single request should not upload more than 150 MB.</p>

+ +

<p>The maximum size of a file one can upload to an upload session is +350 GB.</p>

+ +

<p>Calling this method may update the cursor received. In particular, +the offset variable will be increased to match the new position. This +allows you to make subsequent calls to the endpoint using the same +cursor, as you can see in the example.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+    <pre class="example code"><code># Rely on the offset position updated by `upload_session_append_v2`
+ +

client = DropboxApi::Client.new +cursor = client.upload_session_start(&#39;abc&#39;) # +cursor.offset =&gt; 3 client.upload_session_append_v2(cursor, +&#39;def&#39;) # cursor.offset =&gt; 6 +client.upload_session_append_v2(cursor, &#39;ghi&#39;) # +cursor.offset =&gt; 9 +client.upload_session_finish(…)</code></pre>

+ +
</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>cursor</span>
+
+    <span class='type'>(<tt><span class='object_link'><a href="../../Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">DropboxApi::Metadata::UploadSessionCursor</a></span></tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Contains the
+ +

upload session ID and the offset. This cursor will have its offset updated +after a successful call.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">close</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If <code>true</code>, the current session will be
+ +

closed, at which point you won&#39;t be able to call <span +class='object_link'><a +href=“../../Client.html#upload_session_append_v2-instance_method” +title=“DropboxApi::Client#upload_session_append_v2 +(method)”>Client#upload_session_append_v2</a></span> anymore +with the current session. The default for this field is +false.</p> </div>

+ +
      </li>
+
+  </ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li>UploadSessionCursor</li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

39 40 41 42 43 44 45 46 47 48 49</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/upload_session_append_v2.rb', line 39</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:upload_session_append_v2</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='comma'>,</span> <span class='id identifier +rubyid_content'>content</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:close</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_cursor'>cursor</span><span class='period'>.</span><span class='id identifier rubyid_offset'>offset</span> <span class='op'>+=</span> <span class='id identifier rubyid_content'>content</span><span class='period'>.</span><span class='id identifier rubyid_bytesize'>bytesize</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/UploadSessionFinish_html.html b/doc/docs/DropboxApi/Endpoints/Files/UploadSessionFinish_html.html new file mode 100644 index 00000000..f06616e9 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/UploadSessionFinish_html.html @@ -0,0 +1,979 @@ + + + + + + +UploadSessionFinish.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::UploadSessionFinish
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::UploadSessionFinish";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">UploadSessionFinish</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::UploadSessionFinish
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::UploadSessionFinish</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/upload_session_finish.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/upload_session/finish</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/UploadSessionFinishError.html" title="DropboxApi::Errors::UploadSessionFinishError (class)">UploadSessionFinishError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#upload_session_finish-instance_method" title="#upload_session_finish (instance method)">#<strong>upload_session_finish</strong>(cursor, commit, content = nil)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Finish an upload session and save the uploaded data to the given file path.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../ContentUpload.html#build_connection-instance_method" title="DropboxApi::Endpoints::ContentUpload#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../ContentUpload.html#build_request-instance_method" title="DropboxApi::Endpoints::ContentUpload#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../ContentUpload.html#perform_request-instance_method" title="DropboxApi::Endpoints::ContentUpload#perform_request (method)">#perform_request</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="upload_session_finish-instance_method">
+
+  #<strong>upload_session_finish</strong>(cursor, commit, content = nil)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Finish an upload session and save the uploaded data to the given file
+ +

path.</p>

+ +

<p>A single request should not upload more than 150 MB.</p>

+ +

<p>The maximum size of a file one can upload to an upload session is +350 GB.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>cursor</span>
+
+    <span class='type'>(<tt><span class='object_link'><a href="../../Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">DropboxApi::Metadata::UploadSessionCursor</a></span></tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Contains the
+ +

upload session ID and the offset.</p> </div>

+ +
</li>
+
+<li>
+
+    <span class='name'>commit</span>
+
+    <span class='type'>(<tt><span class='object_link'><a href="../../Metadata/CommitInfo.html" title="DropboxApi::Metadata::CommitInfo (class)">DropboxApi::Metadata::CommitInfo</a></span></tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Contains the path and
+ +

other optional modifiers for the commit.</p> </div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

22 23 24 25 26 27</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/upload_session_finish.rb', line 22</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:upload_session_finish</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_cursor'>cursor</span><span +class='comma'>,</span> <span class='id identifier +rubyid_commit'>commit</span><span +class='comma'>,</span> <span class='id identifier +rubyid_content'>content</span> <span +class='op'>=</span> <span +class='kw'>nil</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span><span class='comma'>,</span>
+  <span class='label'>commit:</span> <span class='id identifier rubyid_commit'>commit</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span>
+<span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/UploadSessionStart_html.html b/doc/docs/DropboxApi/Endpoints/Files/UploadSessionStart_html.html new file mode 100644 index 00000000..b8a2ba2c --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/UploadSessionStart_html.html @@ -0,0 +1,1001 @@ + + + + + + +UploadSessionStart.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::UploadSessionStart
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::UploadSessionStart";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">UploadSessionStart</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::UploadSessionStart
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::UploadSessionStart</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/upload_session_start.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/upload_session/start</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/UploadSessionStart.html" title="DropboxApi::Results::UploadSessionStart (class)">UploadSessionStart</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='kw'>nil</span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#upload_session_start-instance_method" title="#upload_session_start (instance method)">#<strong>upload_session_start</strong>(content, options = {})  &#x21d2; DropboxApi::Metadata::UploadSessionCursor </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../ContentUpload.html#build_connection-instance_method" title="DropboxApi::Endpoints::ContentUpload#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../ContentUpload.html#build_request-instance_method" title="DropboxApi::Endpoints::ContentUpload#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../ContentUpload.html#perform_request-instance_method" title="DropboxApi::Endpoints::ContentUpload#perform_request (method)">#perform_request</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="upload_session_start-instance_method">
+
+  #<strong>upload_session_start</strong>(content, options = {})  &#x21d2; <tt><span class='object_link'><a href="../../Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">DropboxApi::Metadata::UploadSessionCursor</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Upload sessions allow you to upload a single file in one or more
+ +

requests, for example where the size of the file is greater than 150 +MB.</p>

+ +

<p>This call starts a new upload session with the given data. You can +then use <span class='object_link'><a +href=“../../Client.html#upload_session_append_v2-instance_method” +title=“DropboxApi::Client#upload_session_append_v2 +(method)”>Client#upload_session_append_v2</a></span> to add +more data and <span class='object_link'><a +href=“../../Client.html#upload_session_finish-instance_method” +title=“DropboxApi::Client#upload_session_finish +(method)”>Client#upload_session_finish</a></span> to save +all the data to a file in Dropbox.</p>

+ +

<p>A single request should not upload more than 150 MB of file +contents.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">close</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If <code>true</code>, the current session will be
+ +

closed, at which point you won&#39;t be able to call <span +class='object_link'><a +href=“../../Client.html#upload_session_append_v2-instance_method” +title=“DropboxApi::Client#upload_session_append_v2 +(method)”>Client#upload_session_append_v2</a></span> anymore +with the current session. The default for this field is +false.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt><span class='object_link'><a href="../../Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">DropboxApi::Metadata::UploadSessionCursor</a></span></tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The session cursor
+ +

that you can use to continue the upload afterwards.</p> </div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

26 27 28 29 30 31 32 33 34 35 36 37</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/upload_session_start.rb', line 26</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:upload_session_start</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_content'>content</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:close</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_session'>session</span> <span class='op'>=</span> <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
+
+<span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">UploadSessionCursor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>session_id</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_session_id'>session_id</span><span class='comma'>,</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>offset</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_content'>content</span><span class='period'>.</span><span class='id identifier rubyid_bytesize'>bytesize</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files/Upload_html.html b/doc/docs/DropboxApi/Endpoints/Files/Upload_html.html new file mode 100644 index 00000000..6f63699a --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files/Upload_html.html @@ -0,0 +1,1134 @@ + + + + + + +Upload.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Files::Upload
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files::Upload";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
+   &raquo; 
+  <span class="title">Upload</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Files::Upload
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Files::Upload</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/upload.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/files/upload</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/UploadError.html" title="DropboxApi::Errors::UploadError (class)">UploadError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#upload-instance_method" title="#upload (instance method)">#<strong>upload</strong>(path, content, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Creates a new file.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../ContentUpload.html#build_connection-instance_method" title="DropboxApi::Endpoints::ContentUpload#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../ContentUpload.html#build_request-instance_method" title="DropboxApi::Endpoints::ContentUpload#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../ContentUpload.html#perform_request-instance_method" title="DropboxApi::Endpoints::ContentUpload#perform_request (method)">#perform_request</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="upload-instance_method">
+
+  #<strong>upload</strong>(path, content, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Creates a new file.</p>
+ +

<p>Do not use this to upload a file larger than 150 MB.</p>

+ +

<p>For larger files you can use <span +class='object_link'><a +href=“../../Client.html#upload_by_chunks-instance_method” +title=“DropboxApi::Client#upload_by_chunks +(method)”>Client#upload_by_chunks</a></span>.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+    <pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
+ +

<span class='id identifier +rubyid_file_content'>file_content</span> <span +class='op'>=</span> <span +class='const'>IO</span><span +class='period'>.</span><span class='id identifier +rubyid_read'>read</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>local_image.png</span><span +class='tstring_end'>&quot;</span></span> +<span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/image.png</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span class='id identifier +rubyid_file_content'>file_content</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Metadata::File: +@name=&quot;image.png&quot; +…&gt;</span></code></pre>

+ +
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
+ +

<span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>Contents of a plain text +file.</span><span +class='tstring_end'>&quot;</span></span> +<span class='comment'>#=&gt; +#&lt;DropboxApi::Metadata::File: @name=&quot;file.txt&quot; +…&gt;</span></code></pre>

+ +
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
+ +

<span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_upload'>upload</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/file.txt</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>File contents…</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='symbol'>:mode</span> <span +class='op'>=&gt;</span> <span +class='symbol'>:add</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Metadata::File: +@name=&quot;file (1).txt&quot; +…&gt;</span></code></pre>

+ +
</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path in the user&#39;s Dropbox to save the file.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>content</span>
+
+    <span class='type'></span>
+
+    &mdash;
+    <div class='inline'><p>The contents of the file that will be uploaded. This
+ +

could be the result of the IO::read method.</p> +</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">mode</span>
+      <span class="type">(<tt><span class='object_link'><a href="../../Metadata/WriteMode.html" title="DropboxApi::Metadata::WriteMode (class)">DropboxApi::Metadata::WriteMode</a></span></tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Selects what to
+ +

do if the file already exists. The default is add.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">autorename</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If there&#39;s a conflict, as determined
+ +

by mode, have the Dropbox server try to autorename the file to +avoid conflict. The default for this field is false.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">client_modified</span>
+  <span class="type">(<tt>DateTime</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>The value to store as the
+ +

client_modified timestamp. Dropbox automatically records the +time at which the file was written to the Dropbox servers. It can also +record an additional timestamp, provided by Dropbox desktop clients, mobile +clients, and API apps of when the file was actually created or +modified.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">mute</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Normally, users are made aware of any
+ +

file modifications in their Dropbox account via notifications in the client +software. If true, this tells the clients that this +modification shouldn&#39;t result in a user notification. The default +for this field is false.</p> </div>

+ +
      </li>
+
+  </ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li><span class='object_link'><a href="../../Metadata/WriteMode.html" title="DropboxApi::Metadata::WriteMode (class)">Metadata::WriteMode</a></span></li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

50 51 52 53 54 55 56 57 58 59 60 61</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/upload.rb', line 50</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:upload</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_content'>content</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:mode</span><span class='comma'>,</span>
+  <span class='symbol'>:autorename</span><span class='comma'>,</span>
+  <span class='symbol'>:client_modified</span><span class='comma'>,</span>
+  <span class='symbol'>:mute</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span>
+<span class='id identifier rubyid_commit_info'>commit_info</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/CommitInfo.html" title="DropboxApi::Metadata::CommitInfo (class)">CommitInfo</a></span></span><span class='period'>.</span><span class='id identifier rubyid_build_from_options'><span class='object_link'><a href="../../Metadata/CommitInfo.html#build_from_options-class_method" title="DropboxApi::Metadata::CommitInfo.build_from_options (method)">build_from_options</a></span></span> <span class='id identifier rubyid_options'>options</span>
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_commit_info'>commit_info</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Files_html.html b/doc/docs/DropboxApi/Endpoints/Files_html.html new file mode 100644 index 00000000..3afdc597 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Files_html.html @@ -0,0 +1,800 @@ + + + + + + +Files.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Module: DropboxApi::Endpoints::Files
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Files";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span>
+   &raquo; 
+  <span class="title">Files</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Module: DropboxApi::Endpoints::Files
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/files/copy.rb<span class="defines">,<br />
+lib/dropbox_api/endpoints/files/move.rb,<br /> lib/dropbox_api/endpoints/files/delete.rb,<br /> lib/dropbox_api/endpoints/files/search.rb,<br /> lib/dropbox_api/endpoints/files/upload.rb,<br /> lib/dropbox_api/endpoints/files/restore.rb,<br /> lib/dropbox_api/endpoints/files/download.rb,<br /> lib/dropbox_api/endpoints/files/save_url.rb,<br /> lib/dropbox_api/endpoints/files/copy_batch.rb,<br /> lib/dropbox_api/endpoints/files/get_preview.rb,<br /> lib/dropbox_api/endpoints/files/list_folder.rb,<br /> lib/dropbox_api/endpoints/files/delete_batch.rb,<br /> lib/dropbox_api/endpoints/files/get_metadata.rb,<br /> lib/dropbox_api/endpoints/files/create_folder.rb,<br /> lib/dropbox_api/endpoints/files/get_thumbnail.rb,<br /> lib/dropbox_api/endpoints/files/list_revisions.rb,<br /> lib/dropbox_api/endpoints/files/search_continue.rb,<br /> lib/dropbox_api/endpoints/files/copy_batch_check.rb,<br /> lib/dropbox_api/endpoints/files/copy_reference_get.rb,<br /> lib/dropbox_api/endpoints/files/delete_batch_check.rb,<br /> lib/dropbox_api/endpoints/files/get_temporary_link.rb,<br /> lib/dropbox_api/endpoints/files/permanently_delete.rb,<br /> lib/dropbox_api/endpoints/files/copy_reference_save.rb,<br /> lib/dropbox_api/endpoints/files/create_folder_batch.rb,<br /> lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb,<br /> lib/dropbox_api/endpoints/files/list_folder_continue.rb,<br /> lib/dropbox_api/endpoints/files/list_folder_longpoll.rb,<br /> lib/dropbox_api/endpoints/files/upload_session_start.rb,<br /> lib/dropbox_api/endpoints/files/upload_session_finish.rb,<br /> lib/dropbox_api/endpoints/files/upload_session_append_v2.rb,<br /> lib/dropbox_api/endpoints/files/create_folder_batch_check.rb,<br /> lib/dropbox_api/endpoints/files/save_url_check_job_status.rb,<br /> lib/dropbox_api/endpoints/file_requests/create_file_request.rb,<br /> lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb</span>
+ +

</dd>

+ +
</dl>
+ +

</div>

+ +

<h2>Defined Under Namespace</h2> <p class=“children”>

+ +
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Files/Copy.html" title="DropboxApi::Endpoints::Files::Copy (class)">Copy</a></span>, <span class='object_link'><a href="Files/CopyBatch.html" title="DropboxApi::Endpoints::Files::CopyBatch (class)">CopyBatch</a></span>, <span class='object_link'><a href="Files/CopyBatchCheck.html" title="DropboxApi::Endpoints::Files::CopyBatchCheck (class)">CopyBatchCheck</a></span>, <span class='object_link'><a href="Files/CopyReferenceGet.html" title="DropboxApi::Endpoints::Files::CopyReferenceGet (class)">CopyReferenceGet</a></span>, <span class='object_link'><a href="Files/CopyReferenceSave.html" title="DropboxApi::Endpoints::Files::CopyReferenceSave (class)">CopyReferenceSave</a></span>, <span class='object_link'><a href="Files/CreateFileRequest.html" title="DropboxApi::Endpoints::Files::CreateFileRequest (class)">CreateFileRequest</a></span>, <span class='object_link'><a href="Files/CreateFolder.html" title="DropboxApi::Endpoints::Files::CreateFolder (class)">CreateFolder</a></span>, <span class='object_link'><a href="Files/CreateFolderBatch.html" title="DropboxApi::Endpoints::Files::CreateFolderBatch (class)">CreateFolderBatch</a></span>, <span class='object_link'><a href="Files/CreateFolderBatchCheck.html" title="DropboxApi::Endpoints::Files::CreateFolderBatchCheck (class)">CreateFolderBatchCheck</a></span>, <span class='object_link'><a href="Files/Delete.html" title="DropboxApi::Endpoints::Files::Delete (class)">Delete</a></span>, <span class='object_link'><a href="Files/DeleteBatch.html" title="DropboxApi::Endpoints::Files::DeleteBatch (class)">DeleteBatch</a></span>, <span class='object_link'><a href="Files/DeleteBatchCheck.html" title="DropboxApi::Endpoints::Files::DeleteBatchCheck (class)">DeleteBatchCheck</a></span>, <span class='object_link'><a href="Files/Download.html" title="DropboxApi::Endpoints::Files::Download (class)">Download</a></span>, <span class='object_link'><a href="Files/GetMetadata.html" title="DropboxApi::Endpoints::Files::GetMetadata (class)">GetMetadata</a></span>, <span class='object_link'><a href="Files/GetPreview.html" title="DropboxApi::Endpoints::Files::GetPreview (class)">GetPreview</a></span>, <span class='object_link'><a href="Files/GetTemporaryLink.html" title="DropboxApi::Endpoints::Files::GetTemporaryLink (class)">GetTemporaryLink</a></span>, <span class='object_link'><a href="Files/GetThumbnail.html" title="DropboxApi::Endpoints::Files::GetThumbnail (class)">GetThumbnail</a></span>, <span class='object_link'><a href="Files/GetThumbnailBatch.html" title="DropboxApi::Endpoints::Files::GetThumbnailBatch (class)">GetThumbnailBatch</a></span>, <span class='object_link'><a href="Files/ListFolder.html" title="DropboxApi::Endpoints::Files::ListFolder (class)">ListFolder</a></span>, <span class='object_link'><a href="Files/ListFolderContinue.html" title="DropboxApi::Endpoints::Files::ListFolderContinue (class)">ListFolderContinue</a></span>, <span class='object_link'><a href="Files/ListFolderGetLatestCursor.html" title="DropboxApi::Endpoints::Files::ListFolderGetLatestCursor (class)">ListFolderGetLatestCursor</a></span>, <span class='object_link'><a href="Files/ListFolderLongpoll.html" title="DropboxApi::Endpoints::Files::ListFolderLongpoll (class)">ListFolderLongpoll</a></span>, <span class='object_link'><a href="Files/ListRevisions.html" title="DropboxApi::Endpoints::Files::ListRevisions (class)">ListRevisions</a></span>, <span class='object_link'><a href="Files/Move.html" title="DropboxApi::Endpoints::Files::Move (class)">Move</a></span>, <span class='object_link'><a href="Files/PermanentlyDelete.html" title="DropboxApi::Endpoints::Files::PermanentlyDelete (class)">PermanentlyDelete</a></span>, <span class='object_link'><a href="Files/Restore.html" title="DropboxApi::Endpoints::Files::Restore (class)">Restore</a></span>, <span class='object_link'><a href="Files/SaveUrl.html" title="DropboxApi::Endpoints::Files::SaveUrl (class)">SaveUrl</a></span>, <span class='object_link'><a href="Files/SaveUrlCheckJobStatus.html" title="DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus (class)">SaveUrlCheckJobStatus</a></span>, <span class='object_link'><a href="Files/Search.html" title="DropboxApi::Endpoints::Files::Search (class)">Search</a></span>, <span class='object_link'><a href="Files/SearchContinue.html" title="DropboxApi::Endpoints::Files::SearchContinue (class)">SearchContinue</a></span>, <span class='object_link'><a href="Files/Upload.html" title="DropboxApi::Endpoints::Files::Upload (class)">Upload</a></span>, <span class='object_link'><a href="Files/UploadSessionAppendV2.html" title="DropboxApi::Endpoints::Files::UploadSessionAppendV2 (class)">UploadSessionAppendV2</a></span>, <span class='object_link'><a href="Files/UploadSessionFinish.html" title="DropboxApi::Endpoints::Files::UploadSessionFinish (class)">UploadSessionFinish</a></span>, <span class='object_link'><a href="Files/UploadSessionStart.html" title="DropboxApi::Endpoints::Files::UploadSessionStart (class)">UploadSessionStart</a></span>
+ +

</p>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/RpcContent_html.html b/doc/docs/DropboxApi/Endpoints/RpcContent_html.html new file mode 100644 index 00000000..f99e544f --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/RpcContent_html.html @@ -0,0 +1,887 @@ + + + + + + +RpcContent.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::RpcContent
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::RpcContent";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span>
+   &raquo; 
+  <span class="title">RpcContent</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::RpcContent
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::RpcContent</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/rpc_content.rb</dd>
+</dl>
+ +

</div>

+ +

<div id=“subclasses”>

+ +
<h2>Direct Known Subclasses</h2>
+<p class="children"><span class='object_link'><a href="Files/GetThumbnailBatch.html" title="DropboxApi::Endpoints::Files::GetThumbnailBatch (class)">Files::GetThumbnailBatch</a></span></p>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_connection-instance_method" title="#build_connection (instance method)">#<strong>build_connection</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build_connection-instance_method">
+
+  #<strong>build_connection</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/rpc_content.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_connection'>build_connection</span>

+ +
<span class='ivar'>@connection</span> <span class='op'>=</span> <span class='ivar'>@builder</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://content.dropboxapi.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
+  <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='symbol'>:decode_result</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/RpcNotify_html.html b/doc/docs/DropboxApi/Endpoints/RpcNotify_html.html new file mode 100644 index 00000000..ea6b4d20 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/RpcNotify_html.html @@ -0,0 +1,889 @@ + + + + + + +RpcNotify.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::RpcNotify
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::RpcNotify";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span>
+   &raquo; 
+  <span class="title">RpcNotify</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::RpcNotify
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::RpcNotify</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/rpc_notify.rb</dd>
+</dl>
+ +

</div>

+ +

<div id=“subclasses”>

+ +
<h2>Direct Known Subclasses</h2>
+<p class="children"><span class='object_link'><a href="Files/ListFolderLongpoll.html" title="DropboxApi::Endpoints::Files::ListFolderLongpoll (class)">Files::ListFolderLongpoll</a></span></p>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_connection-instance_method" title="#build_connection (instance method)">#<strong>build_connection</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build_connection-instance_method">
+
+  #<strong>build_connection</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/rpc_notify.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_connection'>build_connection</span>

+ +
<span class='ivar'>@connection</span> <span class='op'>=</span> <span class='ivar'>@builder</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://notify.dropboxapi.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
+  <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Authorization</span><span class='tstring_end'>&#39;</span></span>
+
+  <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='symbol'>:decode_result</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Rpc_html.html b/doc/docs/DropboxApi/Endpoints/Rpc_html.html new file mode 100644 index 00000000..1caab0a3 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Rpc_html.html @@ -0,0 +1,982 @@ + + + + + + +Rpc.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Rpc
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Rpc";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span>
+   &raquo; 
+  <span class="title">Rpc</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Rpc
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Rpc</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/rpc.rb</dd>
+</dl>
+ +

</div>

+ +

<div id=“subclasses”>

+ +
<h2>Direct Known Subclasses</h2>
+<p class="children"><span class='object_link'><a href="Auth/TokenRevoke.html" title="DropboxApi::Endpoints::Auth::TokenRevoke (class)">Auth::TokenRevoke</a></span>, <span class='object_link'><a href="Files/Copy.html" title="DropboxApi::Endpoints::Files::Copy (class)">Files::Copy</a></span>, <span class='object_link'><a href="Files/CopyBatch.html" title="DropboxApi::Endpoints::Files::CopyBatch (class)">Files::CopyBatch</a></span>, <span class='object_link'><a href="Files/CopyBatchCheck.html" title="DropboxApi::Endpoints::Files::CopyBatchCheck (class)">Files::CopyBatchCheck</a></span>, <span class='object_link'><a href="Files/CopyReferenceGet.html" title="DropboxApi::Endpoints::Files::CopyReferenceGet (class)">Files::CopyReferenceGet</a></span>, <span class='object_link'><a href="Files/CopyReferenceSave.html" title="DropboxApi::Endpoints::Files::CopyReferenceSave (class)">Files::CopyReferenceSave</a></span>, <span class='object_link'><a href="Files/CreateFileRequest.html" title="DropboxApi::Endpoints::Files::CreateFileRequest (class)">Files::CreateFileRequest</a></span>, <span class='object_link'><a href="Files/CreateFolder.html" title="DropboxApi::Endpoints::Files::CreateFolder (class)">Files::CreateFolder</a></span>, <span class='object_link'><a href="Files/CreateFolderBatch.html" title="DropboxApi::Endpoints::Files::CreateFolderBatch (class)">Files::CreateFolderBatch</a></span>, <span class='object_link'><a href="Files/CreateFolderBatchCheck.html" title="DropboxApi::Endpoints::Files::CreateFolderBatchCheck (class)">Files::CreateFolderBatchCheck</a></span>, <span class='object_link'><a href="Files/Delete.html" title="DropboxApi::Endpoints::Files::Delete (class)">Files::Delete</a></span>, <span class='object_link'><a href="Files/DeleteBatch.html" title="DropboxApi::Endpoints::Files::DeleteBatch (class)">Files::DeleteBatch</a></span>, <span class='object_link'><a href="Files/DeleteBatchCheck.html" title="DropboxApi::Endpoints::Files::DeleteBatchCheck (class)">Files::DeleteBatchCheck</a></span>, <span class='object_link'><a href="Files/GetMetadata.html" title="DropboxApi::Endpoints::Files::GetMetadata (class)">Files::GetMetadata</a></span>, <span class='object_link'><a href="Files/GetTemporaryLink.html" title="DropboxApi::Endpoints::Files::GetTemporaryLink (class)">Files::GetTemporaryLink</a></span>, <span class='object_link'><a href="Files/ListFolder.html" title="DropboxApi::Endpoints::Files::ListFolder (class)">Files::ListFolder</a></span>, <span class='object_link'><a href="Files/ListFolderContinue.html" title="DropboxApi::Endpoints::Files::ListFolderContinue (class)">Files::ListFolderContinue</a></span>, <span class='object_link'><a href="Files/ListFolderGetLatestCursor.html" title="DropboxApi::Endpoints::Files::ListFolderGetLatestCursor (class)">Files::ListFolderGetLatestCursor</a></span>, <span class='object_link'><a href="Files/ListRevisions.html" title="DropboxApi::Endpoints::Files::ListRevisions (class)">Files::ListRevisions</a></span>, <span class='object_link'><a href="Files/Move.html" title="DropboxApi::Endpoints::Files::Move (class)">Files::Move</a></span>, <span class='object_link'><a href="Files/PermanentlyDelete.html" title="DropboxApi::Endpoints::Files::PermanentlyDelete (class)">Files::PermanentlyDelete</a></span>, <span class='object_link'><a href="Files/Restore.html" title="DropboxApi::Endpoints::Files::Restore (class)">Files::Restore</a></span>, <span class='object_link'><a href="Files/SaveUrl.html" title="DropboxApi::Endpoints::Files::SaveUrl (class)">Files::SaveUrl</a></span>, <span class='object_link'><a href="Files/SaveUrlCheckJobStatus.html" title="DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus (class)">Files::SaveUrlCheckJobStatus</a></span>, <span class='object_link'><a href="Files/Search.html" title="DropboxApi::Endpoints::Files::Search (class)">Files::Search</a></span>, <span class='object_link'><a href="Files/SearchContinue.html" title="DropboxApi::Endpoints::Files::SearchContinue (class)">Files::SearchContinue</a></span>, <span class='object_link'><a href="RpcContent.html" title="DropboxApi::Endpoints::RpcContent (class)">RpcContent</a></span>, <span class='object_link'><a href="RpcNotify.html" title="DropboxApi::Endpoints::RpcNotify (class)">RpcNotify</a></span>, <span class='object_link'><a href="Sharing/AddFileMember.html" title="DropboxApi::Endpoints::Sharing::AddFileMember (class)">Sharing::AddFileMember</a></span>, <span class='object_link'><a href="Sharing/AddFolderMember.html" title="DropboxApi::Endpoints::Sharing::AddFolderMember (class)">Sharing::AddFolderMember</a></span>, <span class='object_link'><a href="Sharing/CreateSharedLinkWithSettings.html" title="DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings (class)">Sharing::CreateSharedLinkWithSettings</a></span>, <span class='object_link'><a href="Sharing/GetSharedLinkMetadata.html" title="DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata (class)">Sharing::GetSharedLinkMetadata</a></span>, <span class='object_link'><a href="Sharing/ListFileMembers.html" title="DropboxApi::Endpoints::Sharing::ListFileMembers (class)">Sharing::ListFileMembers</a></span>, <span class='object_link'><a href="Sharing/ListFolderMembers.html" title="DropboxApi::Endpoints::Sharing::ListFolderMembers (class)">Sharing::ListFolderMembers</a></span>, <span class='object_link'><a href="Sharing/ListSharedLinks.html" title="DropboxApi::Endpoints::Sharing::ListSharedLinks (class)">Sharing::ListSharedLinks</a></span>, <span class='object_link'><a href="Sharing/RevokeSharedLink.html" title="DropboxApi::Endpoints::Sharing::RevokeSharedLink (class)">Sharing::RevokeSharedLink</a></span>, <span class='object_link'><a href="Sharing/ShareFolder.html" title="DropboxApi::Endpoints::Sharing::ShareFolder (class)">Sharing::ShareFolder</a></span>, <span class='object_link'><a href="Sharing/UnshareFile.html" title="DropboxApi::Endpoints::Sharing::UnshareFile (class)">Sharing::UnshareFile</a></span>, <span class='object_link'><a href="Users/GetAccount.html" title="DropboxApi::Endpoints::Users::GetAccount (class)">Users::GetAccount</a></span>, <span class='object_link'><a href="Users/GetAccountBatch.html" title="DropboxApi::Endpoints::Users::GetAccountBatch (class)">Users::GetAccountBatch</a></span>, <span class='object_link'><a href="Users/GetCurrentAccount.html" title="DropboxApi::Endpoints::Users::GetCurrentAccount (class)">Users::GetCurrentAccount</a></span>, <span class='object_link'><a href="Users/GetSpaceUsage.html" title="DropboxApi::Endpoints::Users::GetSpaceUsage (class)">Users::GetSpaceUsage</a></span></p>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_connection-instance_method" title="#build_connection (instance method)">#<strong>build_connection</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_request-instance_method" title="#build_request (instance method)">#<strong>build_request</strong>(params)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#request_body-instance_method" title="#request_body (instance method)">#<strong>request_body</strong>(params)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build_connection-instance_method">
+
+  #<strong>build_connection</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/rpc.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_connection'>build_connection</span>

+ +
<span class='ivar'>@connection</span> <span class='op'>=</span> <span class='ivar'>@builder</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://api.dropboxapi.com</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
+  <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='symbol'>:decode_result</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_request-instance_method">
+
+  #<strong>build_request</strong>(params)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

10 11 12 13 14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/rpc.rb', line 10</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_request'>build_request</span><span +class='lparen'>(</span><span class='id identifier +rubyid_params'>params</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_request_headers'>request_headers</span> <span class='op'>=</span> <span class='lbrace'>{</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span>
+<span class='rbrace'>}</span>
+
+<span class='kw'>return</span> <span class='id identifier rubyid_request_body'>request_body</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="request_body-instance_method">
+
+  #<strong>request_body</strong>(params)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

18 19 20 21 22 23 24 25</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/rpc.rb', line 18</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_request_body'>request_body</span><span +class='lparen'>(</span><span class='id identifier +rubyid_params'>params</span><span +class='rparen'>)</span>

+ +
<span class='comment'># This check is only required for compatibility with old JSON serializers
+ +

</span> <span class='kw'>if</span> <span +class='id identifier rubyid_params'>params</span><span +class='period'>.</span><span class='id identifier +rubyid_nil?'>nil?</span>

+ +
  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>null</span><span class='tstring_end'>&#39;</span></span>
+<span class='kw'>else</span>
+  <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Sharing/AddFileMember_html.html b/doc/docs/DropboxApi/Endpoints/Sharing/AddFileMember_html.html new file mode 100644 index 00000000..48b0860d --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Sharing/AddFileMember_html.html @@ -0,0 +1,1056 @@ + + + + + + +AddFileMember.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Sharing::AddFileMember
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Sharing::AddFileMember";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (A)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
+   &raquo; 
+  <span class="title">AddFileMember</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Sharing::AddFileMember
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Sharing::AddFileMember</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/sharing/add_file_member.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/sharing/add_file_member</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/AddFileMemberResultList.html" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/AddFileMemberError.html" title="DropboxApi::Errors::AddFileMemberError (class)">AddFileMemberError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#add_file_member-instance_method" title="#add_file_member (instance method)">#<strong>add_file_member</strong>(file, members, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Adds specified members to a file.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="add_file_member-instance_method">
+
+  #<strong>add_file_member</strong>(file, members, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Adds specified members to a file.</p>
+ +

<p>The members parameter can be an Array or +a single member element. Each element is represented by either a +String or a <span class='object_link'><a +href=“../../Metadata/Member.html” title=“DropboxApi::Metadata::Member +(class)”>Metadata::Member</a></span> object. You can +identify a member using his email or a Dropbox ID.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>file</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>File to which to add members. It can be a path or
+ +

an ID such as id:3kmLmQFnf1AAAAAAAAAAAw.</p> +</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>members</span>
+
+    <span class='type'></span>
+
+    &mdash;
+    <div class='inline'><p>Members to add. Note
+ +

that even if an email address is given, this may result in a user being +directy added to the membership if that email is the user&#39;s main +account email.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">quiet</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Whether added members should be notified
+ +

via email and device notifications of their invite. The default for this +field is false.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">custom_message</span>
+  <span class="type">(<tt>String</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Message to send to added members
+ +

in their invitation. This field is optional.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">access_level</span>
+  <span class="type">(<tt>AccessLevel</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>AccessLevel union object,
+ +

describing what access level we want to give new members. The default for +this is :viewer.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">add_message_as_comment</span>
+  <span class="type">(<tt>String</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Optional message to
+ +

display to added members in their invitation. This field is +optional.</p> </div>

+ +
      </li>
+
+  </ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li><span class='object_link'><a href="../../Metadata/Member.html" title="DropboxApi::Metadata::Member (class)">Metadata::Member</a></span></li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

34 35 36 37 38 39 40 41 42 43 44 45</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/add_file_member.rb', line 34</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:add_file_member</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_file'>file</span><span +class='comma'>,</span> <span class='id identifier +rubyid_members'>members</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='comma'>,</span> <span class='symbol'>:custom_message</span><span class='comma'>,</span> <span class='symbol'>:access_level</span><span class='comma'>,</span> <span class='symbol'>:add_message_as_comment</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:custom_message</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:access_level</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:viewer</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:add_message_as_comment</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>file:</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span>
+  <span class='label'>members:</span> <span class='id identifier rubyid_build_members_param'>build_members_param</span><span class='lparen'>(</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Sharing/AddFolderMember_html.html b/doc/docs/DropboxApi/Endpoints/Sharing/AddFolderMember_html.html new file mode 100644 index 00000000..a2eee26a --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Sharing/AddFolderMember_html.html @@ -0,0 +1,1058 @@ + + + + + + +AddFolderMember.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Sharing::AddFolderMember
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Sharing::AddFolderMember";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (A)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
+   &raquo; 
+  <span class="title">AddFolderMember</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Sharing::AddFolderMember
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Sharing::AddFolderMember</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/sharing/add_folder_member.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/sharing/add_folder_member</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/VoidResult.html" title="DropboxApi::Results::VoidResult (class)">VoidResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/AddFolderMemberError.html" title="DropboxApi::Errors::AddFolderMemberError (class)">AddFolderMemberError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#add_folder_member-instance_method" title="#add_folder_member (instance method)">#<strong>add_folder_member</strong>(folder_id, members, options = {})  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="add_folder_member-instance_method">
+
+  #<strong>add_folder_member</strong>(folder_id, members, options = {})  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Allows an owner or editor (if the ACL update policy allows) of a shared
+ +

folder to add another member.</p>

+ +

<p>For the new member to get access to all the functionality for this +folder, you will need to call mount_folder on their +behalf.</p>

+ +

<p>Apps must have full Dropbox access to use this endpoint.</p>

+ +

<p>The members parameter can be an Array or +a single member element. Each element is represented by either a +String or a <span class='object_link'><a +href=“../../Metadata/AddMember.html” title=“DropboxApi::Metadata::AddMember +(class)”>Metadata::AddMember</a></span> object. This +parameter can be just a string with an email.</p>

+ +

<p>You can also build a <span class='object_link'><a +href=“../../Metadata/AddMember.html” title=“DropboxApi::Metadata::AddMember +(class)”>Metadata::AddMember</a></span> object and use it in +the members parameter, this allows custom options for each +member.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+    <pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
+ +

<span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_add_folder_member'>add_folder_member</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>1363389221</span><span +class='tstring_end'>&quot;</span></span><span +class='comma'>,</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>somebody@test.com</span><span +class='tstring_end'>&quot;</span></span></code></pre>

+ +
</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>folder_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The ID for the shared folder.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>members</span>
+
+    <span class='type'>(<tt>Array&lt;AddMember,String&gt;</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The intended list of members to
+ +

add. Added members will receive invites to join the shared +folder.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">quiet</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Whether added members should be notified
+ +

via email and device notifications of their invite. The default for this +field is False.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">custom_message</span>
+  <span class="type">(<tt>String</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Optional message to display to
+ +

added members in their invitation. This field is optional.</p> +</div>

+ +
      </li>
+
+  </ul>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li><span class='object_link'><a href="../../Metadata/AddMember.html" title="DropboxApi::Metadata::AddMember (class)">Metadata::AddMember</a></span></li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

39 40 41 42 43 44 45 46 47 48</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/add_folder_member.rb', line 39</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:add_folder_member</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_folder_id'>folder_id</span><span +class='comma'>,</span> <span class='id identifier +rubyid_members'>members</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='comma'>,</span> <span class='symbol'>:custom_message</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:custom_message</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>shared_folder_id:</span> <span class='id identifier rubyid_folder_id'>folder_id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
+  <span class='label'>members:</span> <span class='id identifier rubyid_build_members_param'>build_members_param</span><span class='lparen'>(</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings_html.html b/doc/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings_html.html new file mode 100644 index 00000000..b8eae50e --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings_html.html @@ -0,0 +1,1047 @@ + + + + + + +CreateSharedLinkWithSettings.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
+   &raquo; 
+  <span class="title">CreateSharedLinkWithSettings</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/sharing/create_shared_link_with_settings</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">SharedLinkMetadata</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/CreateSharedLinkWithSettingsError.html" title="DropboxApi::Errors::CreateSharedLinkWithSettingsError (class)">CreateSharedLinkWithSettingsError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#create_shared_link_with_settings-instance_method" title="#create_shared_link_with_settings (instance method)">#<strong>create_shared_link_with_settings</strong>(path, settings = {})  &#x21d2; DropboxApi::Metadata::SharedLinkMetadata </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Create a shared link with custom settings.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="create_shared_link_with_settings-instance_method">
+
+  #<strong>create_shared_link_with_settings</strong>(path, settings = {})  &#x21d2; <tt><span class='object_link'><a href="../../Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">DropboxApi::Metadata::SharedLinkMetadata</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Create a shared link with custom settings. If no settings are given then
+ +

the default visibility is :public. (The resolved visibility, though, may +depend on other aspects such as team and shared folder settings).</p>

+ +

<p>NOTE: The settings parameter will only work for pro, +business or enterprise accounts. It will return no permission error +otherwise.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to be shared by the shared link.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>settings</span>
+
+    <span class='type'>(<tt>SharedLinkSettings</tt>)</span>
+
+    <em class="default">(defaults to: <tt>{}</tt>)</em>
+
+    &mdash;
+    <div class='inline'><p>The requested settings for the newly
+ +

created shared link This field is optional.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>settings</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">requested_visibility</span>
+      <span class="type">(<tt>Object</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The requested access for this
+ +

shared link. This field is optional. Must be one of +&quot;public&quot;, &quot;team_only&quot; or +&quot;password&quot;.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">link_password</span>
+  <span class="type">(<tt>Object</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If requested_visibility is
+ +

&quot;password&quot; this is needed to specify the password to +access the link. This field is optional.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">expires</span>
+  <span class="type">(<tt>Object</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Expiration time of the shared link. By default
+ +

the link won&#39;t expire. This field is optional.</p> +</div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt><span class='object_link'><a href="../../Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">DropboxApi::Metadata::SharedLinkMetadata</a></span></tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb', line 32</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:create_shared_link_with_settings</span> +<span class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_settings'>settings</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:requested_visibility</span><span class='comma'>,</span>
+  <span class='symbol'>:link_password</span><span class='comma'>,</span>
+  <span class='symbol'>:expires</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:requested_visibility</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>public</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:link_password</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+<span class='id identifier rubyid_settings'>settings</span><span class='lbracket'>[</span><span class='symbol'>:expires</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
+  <span class='label'>settings:</span> <span class='id identifier rubyid_settings'>settings</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata_html.html b/doc/docs/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata_html.html new file mode 100644 index 00000000..e60bdbb4 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata_html.html @@ -0,0 +1,986 @@ + + + + + + +GetSharedLinkMetadata.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
+   &raquo; 
+  <span class="title">GetSharedLinkMetadata</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/sharing/get_shared_link_metadata</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">SharedLinkMetadata</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/SharedLinkError.html" title="DropboxApi::Errors::SharedLinkError (class)">SharedLinkError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_shared_link_metadata-instance_method" title="#get_shared_link_metadata (instance method)">#<strong>get_shared_link_metadata</strong>(preview_link, options = {})  &#x21d2; SharedFileMembers </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get the Metadata for a shared link.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="get_shared_link_metadata-instance_method">
+
+  #<strong>get_shared_link_metadata</strong>(preview_link, options = {})  &#x21d2; <tt>SharedFileMembers</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get the Metadata for a shared link</p>
+ +

<p>If a preview url is given, returns the shared file or folder that +is represent by that link.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">path</span>
+      <span class="type">(<tt>String</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>If the shared link is to a folder,
+ +

this parameter can be used to retrieve the metadata for a specific file or +sub-folder in this folder. A relative path should be used.</p> +</div>

+ +
</li>
+
+<li>
+  <span class="name">link_password</span>
+  <span class="type">(<tt>String</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>If the shared link has
+ +

a password, this parameter can be used.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>SharedFileMembers</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

23 24 25 26 27 28 29</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb', line 23</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_shared_link_metadata</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_preview_link'>preview_link</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:link_password</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span>
+  <span class='label'>url:</span> <span class='id identifier rubyid_preview_link'>preview_link</span>
+<span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Sharing/ListFileMembers_html.html b/doc/docs/DropboxApi/Endpoints/Sharing/ListFileMembers_html.html new file mode 100644 index 00000000..721fe5b1 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Sharing/ListFileMembers_html.html @@ -0,0 +1,1061 @@ + + + + + + +ListFileMembers.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Sharing::ListFileMembers
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Sharing::ListFileMembers";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
+   &raquo; 
+  <span class="title">ListFileMembers</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Sharing::ListFileMembers
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Sharing::ListFileMembers</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/sharing/list_file_members.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/sharing/list_file_members</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/SharedFileMembers.html" title="DropboxApi::Results::SharedFileMembers (class)">SharedFileMembers</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/SharingFileAccessError.html" title="DropboxApi::Errors::SharingFileAccessError (class)">SharingFileAccessError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_file_members-instance_method" title="#list_file_members (instance method)">#<strong>list_file_members</strong>(file_id, actions = [], options = {})  &#x21d2; SharedFileMembers </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Use to obtain the members who have been invited to a file, both inherited and uninherited members.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="list_file_members-instance_method">
+
+  #<strong>list_file_members</strong>(file_id, actions = [], options = {})  &#x21d2; <tt>SharedFileMembers</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Use to obtain the members who have been invited to a file, both
+ +

inherited and uninherited members.</p>

+ +

<p>Apps must have full Dropbox access to use this endpoint.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+      <p class="example_title"><div class='inline'><p>List file members.</p>
+ +

</div></p>

+ +
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_file_members'>list_file_members</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>&quot;</span></span></code></pre>
+
+  <p class="example_title"><div class='inline'><p>List file members, with detail of permission to make owner.</p>
+ +

</div></p>

+ +
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_file_members'>list_file_members</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:make_owner</span><span class='rbracket'>]</span></code></pre>
+
+  <p class="example_title"><div class='inline'><p>List file members, using the path instead of file ID.</p>
+ +

</div></p>

+ +
    <pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_file_members'>list_file_members</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/my/file.pdf</span><span class='tstring_end'>&quot;</span></span></code></pre>
+
+</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>file_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The ID for the shared file.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>actions</span>
+
+    <span class='type'>(<tt>Array</tt>)</span>
+
+    <em class="default">(defaults to: <tt>[]</tt>)</em>
+
+    &mdash;
+    <div class='inline'><p>This is an optional list of actions. The permissions for the actions
+ +

requested will be included in the result.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">include_inherited</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Whether to include members
+ +

who only have access from a parent shared folder. The default for this +field is true.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">limit</span>
+  <span class="type">(<tt>Numeric</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>The maximum number of results that
+ +

include members, groups and invitees to return per request. The default for +this field is 100.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>SharedFileMembers</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Shared file user and group membership.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li><span class='object_link'><a href="../../Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">Metadata::MemberActionList</a></span></li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

37 38 39 40 41 42 43 44 45</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/list_file_members.rb', line 37</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_file_members</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_file_id'>file_id</span><span +class='comma'>,</span> <span class='id identifier +rubyid_actions'>actions</span> <span +class='op'>=</span> <span +class='lbracket'>[</span><span +class='rbracket'>]</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='comma'>,</span> <span class='symbol'>:include_inherited</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>100</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>file:</span> <span class='id identifier rubyid_file_id'>file_id</span><span class='comma'>,</span>
+  <span class='label'>actions:</span> <span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">MemberActionList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../Metadata/MemberActionList.html#initialize-instance_method" title="DropboxApi::Metadata::MemberActionList#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_actions'>actions</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Sharing/ListFolderMembers_html.html b/doc/docs/DropboxApi/Endpoints/Sharing/ListFolderMembers_html.html new file mode 100644 index 00000000..fd31b5f2 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Sharing/ListFolderMembers_html.html @@ -0,0 +1,1039 @@ + + + + + + +ListFolderMembers.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Sharing::ListFolderMembers
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Sharing::ListFolderMembers";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
+   &raquo; 
+  <span class="title">ListFolderMembers</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Sharing::ListFolderMembers
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Sharing::ListFolderMembers</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/sharing/list_folder_members.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/sharing/list_folder_members</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/SharedFolderMembers.html" title="DropboxApi::Results::SharedFolderMembers (class)">SharedFolderMembers</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/SharedFolderAccessError.html" title="DropboxApi::Errors::SharedFolderAccessError (class)">SharedFolderAccessError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_folder_members-instance_method" title="#list_folder_members (instance method)">#<strong>list_folder_members</strong>(folder_id, actions = [], options = {})  &#x21d2; SharedFolderMembers </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns shared folder membership by its folder ID.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="list_folder_members-instance_method">
+
+  #<strong>list_folder_members</strong>(folder_id, actions = [], options = {})  &#x21d2; <tt>SharedFolderMembers</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns shared folder membership by its folder ID.</p>
+ +

<p>Apps must have full Dropbox access to use this endpoint.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+      <p class="example_title"><div class='inline'><p>List folder members.</p>
+ +

</div></p>

+ +
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder_members'>list_folder_members</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>&quot;</span></span></code></pre>
+
+  <p class="example_title"><div class='inline'><p>List folder members, with detail of permission to make owner.</p>
+ +

</div></p>

+ +
    <pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder_members'>list_folder_members</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:make_owner</span><span class='rbracket'>]</span></code></pre>
+
+</div>
+ +

<p class=“tag_title”>Parameters:</p> <ul class=“param”>

+ +
<li>
+
+    <span class='name'>folder_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The ID for the shared folder.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>actions</span>
+
+    <span class='type'>(<tt>Array</tt>)</span>
+
+    <em class="default">(defaults to: <tt>[]</tt>)</em>
+
+    &mdash;
+    <div class='inline'><p>This is an optional list of actions. The permissions for the actions
+ +

requested will be included in the result.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">limit</span>
+      <span class="type">(<tt>Numeric</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The maximum number of results that
+ +

include members, groups and invitees to return per request. The default for +this field is 1000.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>SharedFolderMembers</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Shared folder user and group membership.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li><span class='object_link'><a href="../../Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">Metadata::MemberActionList</a></span></li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

30 31 32 33 34 35 36 37 38</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/list_folder_members.rb', line 30</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_folder_members</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_folder_id'>folder_id</span><span +class='comma'>,</span> <span class='id identifier +rubyid_actions'>actions</span> <span +class='op'>=</span> <span +class='lbracket'>[</span><span +class='rbracket'>]</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>100</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>shared_folder_id:</span> <span class='id identifier rubyid_folder_id'>folder_id</span><span class='comma'>,</span>
+  <span class='label'>actions:</span> <span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">MemberActionList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../Metadata/MemberActionList.html#initialize-instance_method" title="DropboxApi::Metadata::MemberActionList#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_actions'>actions</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Sharing/ListSharedLinks_html.html b/doc/docs/DropboxApi/Endpoints/Sharing/ListSharedLinks_html.html new file mode 100644 index 00000000..21ff4070 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Sharing/ListSharedLinks_html.html @@ -0,0 +1,990 @@ + + + + + + +ListSharedLinks.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Sharing::ListSharedLinks
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Sharing::ListSharedLinks";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
+   &raquo; 
+  <span class="title">ListSharedLinks</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Sharing::ListSharedLinks
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Sharing::ListSharedLinks</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/sharing/list_shared_links.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/sharing/list_shared_links</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/ListSharedLinksResult.html" title="DropboxApi::Results::ListSharedLinksResult (class)">ListSharedLinksResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/ListSharedLinksError.html" title="DropboxApi::Errors::ListSharedLinksError (class)">ListSharedLinksError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#list_shared_links-instance_method" title="#list_shared_links (instance method)">#<strong>list_shared_links</strong>(options = {})  &#x21d2; ListSharedLinksResult </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>List shared links of this user.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="list_shared_links-instance_method">
+
+  #<strong>list_shared_links</strong>(options = {})  &#x21d2; <tt>ListSharedLinksResult</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>List shared links of this user.</p>
+ +

<p>If no path is given or the path is empty, returns a list of all +shared links for the current user.</p>

+ +

<p>If a non-empty path is given, returns a list of all shared links +that allow access to the given path - direct links to the given path and +links to parent folders of the given path. Links to parent folders can be +suppressed by setting direct_only to true.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">path</span>
+      <span class="type">(<tt>String</tt>)</span>
+      <span class="default">
+
+      </span>
+
+    </li>
+
+    <li>
+      <span class="name">cursor</span>
+      <span class="type">(<tt>String</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>The cursor returned by your last call.</p>
+ +

</div>

+ +
    </li>
+
+    <li>
+      <span class="name">direct_only</span>
+      <span class="type">(<tt>Boolean</tt>)</span>
+      <span class="default">
+
+      </span>
+
+    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>ListSharedLinksResult</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

25 26 27 28 29</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/list_shared_links.rb', line 25</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:list_shared_links</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:cursor</span><span class='comma'>,</span> <span class='symbol'>:direct_only</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Sharing/RevokeSharedLink_html.html b/doc/docs/DropboxApi/Endpoints/Sharing/RevokeSharedLink_html.html new file mode 100644 index 00000000..2ed5924c --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Sharing/RevokeSharedLink_html.html @@ -0,0 +1,951 @@ + + + + + + +RevokeSharedLink.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Sharing::RevokeSharedLink
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Sharing::RevokeSharedLink";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
+   &raquo; 
+  <span class="title">RevokeSharedLink</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Sharing::RevokeSharedLink
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Sharing::RevokeSharedLink</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/sharing/revoke_shared_link</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/VoidResult.html" title="DropboxApi::Results::VoidResult (class)">VoidResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/RevokeSharedLinkError.html" title="DropboxApi::Errors::RevokeSharedLinkError (class)">RevokeSharedLinkError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#revoke_shared_link-instance_method" title="#revoke_shared_link (instance method)">#<strong>revoke_shared_link</strong>(url)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Revoke a shared link.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="revoke_shared_link-instance_method">
+
+  #<strong>revoke_shared_link</strong>(url)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Revoke a shared link.</p>
+ +

<p>Note that even after revoking a shared link to a file, the file +may be accessible if there are shared links leading to any of the file +parent folders. </p>

+ +

<p>A successful response indicates that the shared link was +revoked.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>url</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>shared url which needs to be revoked.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

18 19 20 21 22</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb', line 18</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:revoke_shared_link</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_url'>url</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Sharing/ShareFolder_html.html b/doc/docs/DropboxApi/Endpoints/Sharing/ShareFolder_html.html new file mode 100644 index 00000000..bcd0af10 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Sharing/ShareFolder_html.html @@ -0,0 +1,1059 @@ + + + + + + +ShareFolder.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Sharing::ShareFolder
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Sharing::ShareFolder";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
+   &raquo; 
+  <span class="title">ShareFolder</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Sharing::ShareFolder
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Sharing::ShareFolder</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+    <dt>Includes:</dt>
+    <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/sharing/share_folder.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/sharing/share_folder</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/ShareFolderLaunch.html" title="DropboxApi::Results::ShareFolderLaunch (class)">ShareFolderLaunch</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/ShareFolderError.html" title="DropboxApi::Errors::ShareFolderError (class)">ShareFolderError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#share_folder-instance_method" title="#share_folder (instance method)">#<strong>share_folder</strong>(path, options = {})  &#x21d2; DropboxApi::Results::ShareFolderLaunch </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Share a folder with collaborators.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="share_folder-instance_method">
+
+  #<strong>share_folder</strong>(path, options = {})  &#x21d2; <tt><span class='object_link'><a href="../../Results/ShareFolderLaunch.html" title="DropboxApi::Results::ShareFolderLaunch (class)">DropboxApi::Results::ShareFolderLaunch</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Share a folder with collaborators.</p>
+ +

<p>Most sharing will be completed synchronously. Large folders will +be completed asynchronously. To make testing the async case repeatable, set +force_async.</p>

+ +

<p>If a ShareFolderLaunch.async_job_id is returned, you&#39;ll +need to call check_share_job_status until the action completes to get the +metadata for the folder.</p>

+ +

<p>Apps must have full Dropbox access to use this endpoint.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>path</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>The path to the folder to share. If it does not
+ +

exist, then a new one is created.</p> </div>

+ +
</li>
+ +

</ul>

+ +
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
+<ul class="option">
+
+    <li>
+      <span class="name">member_policy</span>
+      <span class="type">(<tt>:anyone</tt>, <tt>:team</tt>)</span>
+      <span class="default">
+
+      </span>
+
+        &mdash; <div class='inline'><p>Who can be a member of
+ +

this shared folder. Only applicable if the current user is on a team. The +default is :anyone.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">acl_update_policy</span>
+  <span class="type">(<tt>:owner</tt>, <tt>:editors</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Who can add and
+ +

remove members of this shared folder. The default is +:owner.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">shared_link_policy</span>
+  <span class="type">(<tt>:anyone</tt>, <tt>:members</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>The policy to
+ +

apply to shared links created for content inside this shared folder. The +current user must be on a team to set this policy to :members. +The default is anyone.</p> </div>

+ +
</li>
+
+<li>
+  <span class="name">force_async</span>
+  <span class="type">(<tt>Boolean</tt>)</span>
+  <span class="default">
+
+  </span>
+
+    &mdash; <div class='inline'><p>Whether to force the share to
+ +

happen asynchronously. The default for this field is +false.</p> </div>

+ +
    </li>
+
+</ul>
+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt><span class='object_link'><a href="../../Results/ShareFolderLaunch.html" title="DropboxApi::Results::ShareFolderLaunch (class)">DropboxApi::Results::ShareFolderLaunch</a></span></tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Shared folder metadata.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/share_folder.rb', line 37</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:share_folder</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_path'>path</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
+  <span class='symbol'>:member_policy</span><span class='comma'>,</span>
+  <span class='symbol'>:acl_update_policy</span><span class='comma'>,</span>
+  <span class='symbol'>:shared_link_policy</span><span class='comma'>,</span>
+  <span class='symbol'>:force_async</span>
+<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:member_policy</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:anyone</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:acl_update_policy</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:owner</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link_policy</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:anyone</span>
+<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:force_async</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
+
+<span class='kw'>begin</span>
+  <span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+    <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span>
+  <span class='rbrace'>}</span><span class='rparen'>)</span>
+<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/AlreadySharedError.html" title="DropboxApi::Errors::AlreadySharedError (class)">AlreadySharedError</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_error'>error</span>
+  <span class='id identifier rubyid_error'>error</span><span class='period'>.</span><span class='id identifier rubyid_shared_folder'>shared_folder</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Sharing/UnshareFile_html.html b/doc/docs/DropboxApi/Endpoints/Sharing/UnshareFile_html.html new file mode 100644 index 00000000..4f63b5a3 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Sharing/UnshareFile_html.html @@ -0,0 +1,947 @@ + + + + + + +UnshareFile.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Sharing::UnshareFile
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Sharing::UnshareFile";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
+   &raquo; 
+  <span class="title">UnshareFile</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Sharing::UnshareFile
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Sharing::UnshareFile</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/sharing/unshare_file.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/sharing/unshare_file</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/VoidResult.html" title="DropboxApi::Results::VoidResult (class)">VoidResult</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/UnshareFileError.html" title="DropboxApi::Errors::UnshareFileError (class)">UnshareFileError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#unshare_file-instance_method" title="#unshare_file (instance method)">#<strong>unshare_file</strong>(file)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Remove all members from this file.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="unshare_file-instance_method">
+
+  #<strong>unshare_file</strong>(file)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Remove all members from this file. Does not remove inherited members.</p>
+ +

<p>A successful response indicates that the file was +unshared.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>file</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Path or ID of the file in the user&#39;s Dropbox to unshare.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

14 15 16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/unshare_file.rb', line 14</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:unshare_file</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_file'>file</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='label'>file:</span> <span class='id identifier rubyid_file'>file</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Sharing_html.html b/doc/docs/DropboxApi/Endpoints/Sharing_html.html new file mode 100644 index 00000000..ea957d24 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Sharing_html.html @@ -0,0 +1,800 @@ + + + + + + +Sharing.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Module: DropboxApi::Endpoints::Sharing
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Sharing";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span>
+   &raquo; 
+  <span class="title">Sharing</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Module: DropboxApi::Endpoints::Sharing
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/sharing/share_folder.rb<span class="defines">,<br />
+lib/dropbox_api/endpoints/sharing/unshare_file.rb,<br /> lib/dropbox_api/endpoints/sharing/add_file_member.rb,<br /> lib/dropbox_api/endpoints/sharing/add_folder_member.rb,<br /> lib/dropbox_api/endpoints/sharing/list_file_members.rb,<br /> lib/dropbox_api/endpoints/sharing/list_shared_links.rb,<br /> lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb,<br /> lib/dropbox_api/endpoints/sharing/list_folder_members.rb,<br /> lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb,<br /> lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb</span>
+ +

</dd>

+ +
</dl>
+ +

</div>

+ +

<h2>Defined Under Namespace</h2> <p class=“children”>

+ +
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Sharing/AddFileMember.html" title="DropboxApi::Endpoints::Sharing::AddFileMember (class)">AddFileMember</a></span>, <span class='object_link'><a href="Sharing/AddFolderMember.html" title="DropboxApi::Endpoints::Sharing::AddFolderMember (class)">AddFolderMember</a></span>, <span class='object_link'><a href="Sharing/CreateSharedLinkWithSettings.html" title="DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings (class)">CreateSharedLinkWithSettings</a></span>, <span class='object_link'><a href="Sharing/GetSharedLinkMetadata.html" title="DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata (class)">GetSharedLinkMetadata</a></span>, <span class='object_link'><a href="Sharing/ListFileMembers.html" title="DropboxApi::Endpoints::Sharing::ListFileMembers (class)">ListFileMembers</a></span>, <span class='object_link'><a href="Sharing/ListFolderMembers.html" title="DropboxApi::Endpoints::Sharing::ListFolderMembers (class)">ListFolderMembers</a></span>, <span class='object_link'><a href="Sharing/ListSharedLinks.html" title="DropboxApi::Endpoints::Sharing::ListSharedLinks (class)">ListSharedLinks</a></span>, <span class='object_link'><a href="Sharing/RevokeSharedLink.html" title="DropboxApi::Endpoints::Sharing::RevokeSharedLink (class)">RevokeSharedLink</a></span>, <span class='object_link'><a href="Sharing/ShareFolder.html" title="DropboxApi::Endpoints::Sharing::ShareFolder (class)">ShareFolder</a></span>, <span class='object_link'><a href="Sharing/UnshareFile.html" title="DropboxApi::Endpoints::Sharing::UnshareFile (class)">UnshareFile</a></span>
+ +

</p>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Users/GetAccountBatch_html.html b/doc/docs/DropboxApi/Endpoints/Users/GetAccountBatch_html.html new file mode 100644 index 00000000..fb0de5c1 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Users/GetAccountBatch_html.html @@ -0,0 +1,959 @@ + + + + + + +GetAccountBatch.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Users::GetAccountBatch
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Users::GetAccountBatch";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Users.html" title="DropboxApi::Endpoints::Users (module)">Users</a></span></span>
+   &raquo; 
+  <span class="title">GetAccountBatch</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Users::GetAccountBatch
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Users::GetAccountBatch</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/users/get_account_batch.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/users/get_account_batch</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/BasicAccountBatch.html" title="DropboxApi::Results::BasicAccountBatch (class)">BasicAccountBatch</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/GetAccountError.html" title="DropboxApi::Errors::GetAccountError (class)">GetAccountError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_account_batch-instance_method" title="#get_account_batch (instance method)">#<strong>get_account_batch</strong>(account_ids)  &#x21d2; Array&lt;BasicAccount&gt; </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get information about multiple user accounts.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="get_account_batch-instance_method">
+
+  #<strong>get_account_batch</strong>(account_ids)  &#x21d2; <tt>Array&lt;BasicAccount&gt;</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get information about multiple user accounts. At most 300 accounts may
+ +

be queried per request.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>account_ids</span>
+
+    <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>List of user account identifiers. Should not
+ +

contain any duplicate account IDs.</p> </div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>Array&lt;BasicAccount&gt;</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Basic information about any account.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/users/get_account_batch.rb', line 15</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_account_batch</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_account_ids'>account_ids</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>account_ids:</span> <span class='id identifier rubyid_account_ids'>account_ids</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Users/GetAccount_html.html b/doc/docs/DropboxApi/Endpoints/Users/GetAccount_html.html new file mode 100644 index 00000000..261a5b71 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Users/GetAccount_html.html @@ -0,0 +1,957 @@ + + + + + + +GetAccount.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Users::GetAccount
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Users::GetAccount";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Users.html" title="DropboxApi::Endpoints::Users (module)">Users</a></span></span>
+   &raquo; 
+  <span class="title">GetAccount</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Users::GetAccount
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Users::GetAccount</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/users/get_account.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/users/get_account</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/BasicAccount.html" title="DropboxApi::Metadata::BasicAccount (class)">BasicAccount</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/GetAccountError.html" title="DropboxApi::Errors::GetAccountError (class)">GetAccountError</a></span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_account-instance_method" title="#get_account (instance method)">#<strong>get_account</strong>(account_id)  &#x21d2; BasicAccount </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get information about a user&#39;s account.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="get_account-instance_method">
+
+  #<strong>get_account</strong>(account_id)  &#x21d2; <tt>BasicAccount</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get information about a user&#39;s account.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>account_id</span>
+
+    <span class='type'>(<tt>String</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>A user&#39;s account identifier.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>BasicAccount</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Basic information about any account.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/users/get_account.rb', line 13</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_account</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_account_id'>account_id</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='label'>account_id:</span> <span class='id identifier rubyid_account_id'>account_id</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Users/GetCurrentAccount_html.html b/doc/docs/DropboxApi/Endpoints/Users/GetCurrentAccount_html.html new file mode 100644 index 00000000..7833363f --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Users/GetCurrentAccount_html.html @@ -0,0 +1,935 @@ + + + + + + +GetCurrentAccount.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Users::GetCurrentAccount
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Users::GetCurrentAccount";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Users.html" title="DropboxApi::Endpoints::Users (module)">Users</a></span></span>
+   &raquo; 
+  <span class="title">GetCurrentAccount</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Users::GetCurrentAccount
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Users::GetCurrentAccount</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/users/get_current_account.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/users/get_current_account</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/BasicAccount.html" title="DropboxApi::Metadata::BasicAccount (class)">BasicAccount</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='kw'>nil</span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_current_account-instance_method" title="#get_current_account (instance method)">#<strong>get_current_account</strong>  &#x21d2; BasicAccount </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get information about the current user&#39;s account.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="get_current_account-instance_method">
+
+  #<strong>get_current_account</strong>  &#x21d2; <tt>BasicAccount</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get information about the current user&#39;s account.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>BasicAccount</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Detailed information about the current user&#39;s account.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/users/get_current_account.rb', line 12</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_current_account</span> <span +class='kw'>do</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='kw'>nil</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Users/GetSpaceUsage_html.html b/doc/docs/DropboxApi/Endpoints/Users/GetSpaceUsage_html.html new file mode 100644 index 00000000..6cdca5de --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Users/GetSpaceUsage_html.html @@ -0,0 +1,935 @@ + + + + + + +GetSpaceUsage.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Endpoints::Users::GetSpaceUsage
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Users::GetSpaceUsage";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Users.html" title="DropboxApi::Endpoints::Users (module)">Users</a></span></span>
+   &raquo; 
+  <span class="title">GetSpaceUsage</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Endpoints::Users::GetSpaceUsage
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
+
+          <li class="next">DropboxApi::Endpoints::Users::GetSpaceUsage</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/users/get_space_usage.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="Method-constant" class="">Method =
+
+      </dt>
+      <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
+
+      <dt id="Path-constant" class="">Path =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/2/users/get_space_usage</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+      <dt id="ResultType-constant" class="">ResultType =
+
+      </dt>
+      <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/SpaceUsage.html" title="DropboxApi::Metadata::SpaceUsage (class)">SpaceUsage</a></span></span></pre></dd>
+
+      <dt id="ErrorType-constant" class="">ErrorType =
+
+      </dt>
+      <dd><pre class="code"><span class='kw'>nil</span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#get_space_usage-instance_method" title="#get_space_usage (instance method)">#<strong>get_space_usage</strong>  &#x21d2; SpaceUsage </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Get the space usage information for the current user&#39;s account.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>, <span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>, <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">DropboxApi::Endpoints::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="get_space_usage-instance_method">
+
+  #<strong>get_space_usage</strong>  &#x21d2; <tt>SpaceUsage</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Get the space usage information for the current user&#39;s account.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>SpaceUsage</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Information about a user&#39;s space usage and quota.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/users/get_space_usage.rb', line 12</span>
+ +

<span class='id identifier +rubyid_add_endpoint'>add_endpoint</span> <span +class='symbol'>:get_space_usage</span> <span +class='kw'>do</span>

+ +
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='kw'>nil</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints/Users_html.html b/doc/docs/DropboxApi/Endpoints/Users_html.html new file mode 100644 index 00000000..8206d6c7 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints/Users_html.html @@ -0,0 +1,800 @@ + + + + + + +Users.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Module: DropboxApi::Endpoints::Users
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints::Users";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span>
+   &raquo; 
+  <span class="title">Users</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Module: DropboxApi::Endpoints::Users
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/users/get_account.rb<span class="defines">,<br />
+lib/dropbox_api/endpoints/users/get_space_usage.rb,<br /> lib/dropbox_api/endpoints/users/get_account_batch.rb,<br /> lib/dropbox_api/endpoints/users/get_current_account.rb</span>
+ +

</dd>

+ +
</dl>
+ +

</div>

+ +

<h2>Defined Under Namespace</h2> <p class=“children”>

+ +
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Users/GetAccount.html" title="DropboxApi::Endpoints::Users::GetAccount (class)">GetAccount</a></span>, <span class='object_link'><a href="Users/GetAccountBatch.html" title="DropboxApi::Endpoints::Users::GetAccountBatch (class)">GetAccountBatch</a></span>, <span class='object_link'><a href="Users/GetCurrentAccount.html" title="DropboxApi::Endpoints::Users::GetCurrentAccount (class)">GetCurrentAccount</a></span>, <span class='object_link'><a href="Users/GetSpaceUsage.html" title="DropboxApi::Endpoints::Users::GetSpaceUsage (class)">GetSpaceUsage</a></span>
+ +

</p>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Endpoints_html.html b/doc/docs/DropboxApi/Endpoints_html.html new file mode 100644 index 00000000..3cd84d05 --- /dev/null +++ b/doc/docs/DropboxApi/Endpoints_html.html @@ -0,0 +1,802 @@ + + + + + + +Endpoints.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Module: DropboxApi::Endpoints
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Endpoints";
+relpath = '../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../_index.html">Index (E)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+   &raquo; 
+  <span class="title">Endpoints</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Module: DropboxApi::Endpoints
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/endpoints/rpc.rb<span class="defines">,<br />
+lib/dropbox_api/endpoints/base.rb,<br /> lib/dropbox_api/endpoints/rpc_notify.rb,<br /> lib/dropbox_api/endpoints/rpc_content.rb,<br /> lib/dropbox_api/endpoints/content_upload.rb,<br /> lib/dropbox_api/endpoints/content_download.rb</span>
+ +

</dd>

+ +
</dl>
+ +

</div>

+ +

<h2>Defined Under Namespace</h2> <p class=“children”>

+ +
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Endpoints/Auth.html" title="DropboxApi::Endpoints::Auth (module)">Auth</a></span>, <span class='object_link'><a href="Endpoints/Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span>, <span class='object_link'><a href="Endpoints/Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span>, <span class='object_link'><a href="Endpoints/Users.html" title="DropboxApi::Endpoints::Users (module)">Users</a></span>
+
+<strong class="classes">Classes:</strong> <span class='object_link'><a href="Endpoints/Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span>, <span class='object_link'><a href="Endpoints/ContentDownload.html" title="DropboxApi::Endpoints::ContentDownload (class)">ContentDownload</a></span>, <span class='object_link'><a href="Endpoints/ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span>, <span class='object_link'><a href="Endpoints/Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span>, <span class='object_link'><a href="Endpoints/RpcContent.html" title="DropboxApi::Endpoints::RpcContent (class)">RpcContent</a></span>, <span class='object_link'><a href="Endpoints/RpcNotify.html" title="DropboxApi::Endpoints::RpcNotify (class)">RpcNotify</a></span>
+ +

</p>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/AddFileMemberError_html.html b/doc/docs/DropboxApi/Errors/AddFileMemberError_html.html new file mode 100644 index 00000000..2bc90cba --- /dev/null +++ b/doc/docs/DropboxApi/Errors/AddFileMemberError_html.html @@ -0,0 +1,844 @@ + + + + + + +AddFileMemberError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::AddFileMemberError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::AddFileMemberError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (A)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">AddFileMemberError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::AddFileMemberError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::AddFileMemberError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/add_file_member_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>user_error:</span> <span class='const'><span class='object_link'><a href="SharingUserError.html" title="DropboxApi::Errors::SharingUserError (class)">SharingUserError</a></span></span><span class='comma'>,</span>
+<span class='label'>access_error:</span> <span class='const'><span class='object_link'><a href="SharingFileAccessError.html" title="DropboxApi::Errors::SharingFileAccessError (class)">SharingFileAccessError</a></span></span><span class='comma'>,</span>
+<span class='label'>rate_limit:</span> <span class='const'><span class='object_link'><a href="RateLimitError.html" title="DropboxApi::Errors::RateLimitError (class)">RateLimitError</a></span></span><span class='comma'>,</span>
+<span class='label'>invalid_comment:</span> <span class='const'><span class='object_link'><a href="InvalidCommentError.html" title="DropboxApi::Errors::InvalidCommentError (class)">InvalidCommentError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/AddFolderMemberError_html.html b/doc/docs/DropboxApi/Errors/AddFolderMemberError_html.html new file mode 100644 index 00000000..5226f482 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/AddFolderMemberError_html.html @@ -0,0 +1,850 @@ + + + + + + +AddFolderMemberError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::AddFolderMemberError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::AddFolderMemberError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (A)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">AddFolderMemberError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::AddFolderMemberError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::AddFolderMemberError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/add_folder_member_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>access_error:</span> <span class='const'><span class='object_link'><a href="SharedFolderAccessError.html" title="DropboxApi::Errors::SharedFolderAccessError (class)">SharedFolderAccessError</a></span></span><span class='comma'>,</span>
+<span class='label'>email_unverified:</span> <span class='const'><span class='object_link'><a href="EmailUnverifiedError.html" title="DropboxApi::Errors::EmailUnverifiedError (class)">EmailUnverifiedError</a></span></span><span class='comma'>,</span>
+<span class='label'>bad_member:</span> <span class='const'><span class='object_link'><a href="AddMemberSelectorError.html" title="DropboxApi::Errors::AddMemberSelectorError (class)">AddMemberSelectorError</a></span></span><span class='comma'>,</span>
+<span class='label'>cant_share_outside_team:</span> <span class='const'><span class='object_link'><a href="CantShareOutsideTeamError.html" title="DropboxApi::Errors::CantShareOutsideTeamError (class)">CantShareOutsideTeamError</a></span></span><span class='comma'>,</span>
+<span class='label'>too_many_members:</span> <span class='const'><span class='object_link'><a href="TooManyMembersError.html" title="DropboxApi::Errors::TooManyMembersError (class)">TooManyMembersError</a></span></span><span class='comma'>,</span>
+<span class='label'>too_many_pending_invites:</span> <span class='const'><span class='object_link'><a href="TooManyPendingInvitesError.html" title="DropboxApi::Errors::TooManyPendingInvitesError (class)">TooManyPendingInvitesError</a></span></span><span class='comma'>,</span>
+<span class='label'>rate_limit:</span> <span class='const'><span class='object_link'><a href="RateLimitError.html" title="DropboxApi::Errors::RateLimitError (class)">RateLimitError</a></span></span><span class='comma'>,</span>
+<span class='label'>insufficient_plan:</span> <span class='const'><span class='object_link'><a href="InsufficientPlanError.html" title="DropboxApi::Errors::InsufficientPlanError (class)">InsufficientPlanError</a></span></span><span class='comma'>,</span>
+<span class='label'>team_folder:</span> <span class='const'><span class='object_link'><a href="TeamFolderError.html" title="DropboxApi::Errors::TeamFolderError (class)">TeamFolderError</a></span></span><span class='comma'>,</span>
+<span class='label'>no_permission:</span> <span class='const'><span class='object_link'><a href="NoPermissionError.html" title="DropboxApi::Errors::NoPermissionError (class)">NoPermissionError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/AddMemberSelectorError_html.html b/doc/docs/DropboxApi/Errors/AddMemberSelectorError_html.html new file mode 100644 index 00000000..b4717957 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/AddMemberSelectorError_html.html @@ -0,0 +1,845 @@ + + + + + + +AddMemberSelectorError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::AddMemberSelectorError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::AddMemberSelectorError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (A)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">AddMemberSelectorError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::AddMemberSelectorError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::AddMemberSelectorError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/add_member_selector_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>invalid_dropbox_id:</span> <span class='const'><span class='object_link'><a href="InvalidDropboxIdError.html" title="DropboxApi::Errors::InvalidDropboxIdError (class)">InvalidDropboxIdError</a></span></span><span class='comma'>,</span>
+<span class='label'>invalid_email:</span> <span class='const'><span class='object_link'><a href="InvalidEmailError.html" title="DropboxApi::Errors::InvalidEmailError (class)">InvalidEmailError</a></span></span><span class='comma'>,</span>
+<span class='label'>unverified_dropbox_id:</span> <span class='const'><span class='object_link'><a href="UnverifiedDropboxId.html" title="DropboxApi::Errors::UnverifiedDropboxId (class)">UnverifiedDropboxId</a></span></span><span class='comma'>,</span>
+<span class='label'>group_deleted:</span> <span class='const'><span class='object_link'><a href="GroupDeletedError.html" title="DropboxApi::Errors::GroupDeletedError (class)">GroupDeletedError</a></span></span><span class='comma'>,</span>
+<span class='label'>group_not_on_team:</span> <span class='const'><span class='object_link'><a href="GroupNotOnTeamError.html" title="DropboxApi::Errors::GroupNotOnTeamError (class)">GroupNotOnTeamError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/AlreadySharedError_html.html b/doc/docs/DropboxApi/Errors/AlreadySharedError_html.html new file mode 100644 index 00000000..1059a98b --- /dev/null +++ b/doc/docs/DropboxApi/Errors/AlreadySharedError_html.html @@ -0,0 +1,874 @@ + + + + + + +AlreadySharedError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::AlreadySharedError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::AlreadySharedError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (A)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">AlreadySharedError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::AlreadySharedError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::AlreadySharedError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/already_shared_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#shared_folder-instance_method" title="#shared_folder (instance method)">#<strong>shared_folder</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="shared_folder-instance_method">
+
+  #<strong>shared_folder</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/errors/already_shared_error.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_shared_folder'>shared_folder</span>

+ +
<span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/SharedFolder.html" title="DropboxApi::Metadata::SharedFolder (class)">SharedFolder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span> <span class='ivar'>@metadata</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/BadPathError_html.html b/doc/docs/DropboxApi/Errors/BadPathError_html.html new file mode 100644 index 00000000..b57541e5 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/BadPathError_html.html @@ -0,0 +1,822 @@ + + + + + + +BadPathError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::BadPathError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::BadPathError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (B)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">BadPathError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::BadPathError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::BadPathError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/BasicError_html.html b/doc/docs/DropboxApi/Errors/BasicError_html.html new file mode 100644 index 00000000..5e79e940 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/BasicError_html.html @@ -0,0 +1,1002 @@ + + + + + + +BasicError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::BasicError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::BasicError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (B)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">BasicError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::BasicError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">StandardError</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next">DropboxApi::Errors::BasicError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +

<div id=“subclasses”>

+ +
<h2>Direct Known Subclasses</h2>
+<p class="children"><span class='object_link'><a href="AddFileMemberError.html" title="DropboxApi::Errors::AddFileMemberError (class)">AddFileMemberError</a></span>, <span class='object_link'><a href="AddFolderMemberError.html" title="DropboxApi::Errors::AddFolderMemberError (class)">AddFolderMemberError</a></span>, <span class='object_link'><a href="AddMemberSelectorError.html" title="DropboxApi::Errors::AddMemberSelectorError (class)">AddMemberSelectorError</a></span>, <span class='object_link'><a href="AlreadySharedError.html" title="DropboxApi::Errors::AlreadySharedError (class)">AlreadySharedError</a></span>, <span class='object_link'><a href="BadPathError.html" title="DropboxApi::Errors::BadPathError (class)">BadPathError</a></span>, <span class='object_link'><a href="CantCopySharedFolderError.html" title="DropboxApi::Errors::CantCopySharedFolderError (class)">CantCopySharedFolderError</a></span>, <span class='object_link'><a href="CantMoveFolderIntoItselfError.html" title="DropboxApi::Errors::CantMoveFolderIntoItselfError (class)">CantMoveFolderIntoItselfError</a></span>, <span class='object_link'><a href="CantNestSharedFolderError.html" title="DropboxApi::Errors::CantNestSharedFolderError (class)">CantNestSharedFolderError</a></span>, <span class='object_link'><a href="CantShareOutsideTeamError.html" title="DropboxApi::Errors::CantShareOutsideTeamError (class)">CantShareOutsideTeamError</a></span>, <span class='object_link'><a href="ContainsSharedFolderError.html" title="DropboxApi::Errors::ContainsSharedFolderError (class)">ContainsSharedFolderError</a></span>, <span class='object_link'><a href="ConversionError.html" title="DropboxApi::Errors::ConversionError (class)">ConversionError</a></span>, <span class='object_link'><a href="CreateFileRequestError.html" title="DropboxApi::Errors::CreateFileRequestError (class)">CreateFileRequestError</a></span>, <span class='object_link'><a href="CreateFolderBatchError.html" title="DropboxApi::Errors::CreateFolderBatchError (class)">CreateFolderBatchError</a></span>, <span class='object_link'><a href="CreateFolderError.html" title="DropboxApi::Errors::CreateFolderError (class)">CreateFolderError</a></span>, <span class='object_link'><a href="CreateSharedLinkWithSettingsError.html" title="DropboxApi::Errors::CreateSharedLinkWithSettingsError (class)">CreateSharedLinkWithSettingsError</a></span>, <span class='object_link'><a href="CursorClosedError.html" title="DropboxApi::Errors::CursorClosedError (class)">CursorClosedError</a></span>, <span class='object_link'><a href="CursorNotClosedError.html" title="DropboxApi::Errors::CursorNotClosedError (class)">CursorNotClosedError</a></span>, <span class='object_link'><a href="DeleteError.html" title="DropboxApi::Errors::DeleteError (class)">DeleteError</a></span>, <span class='object_link'><a href="DisallowedNameError.html" title="DropboxApi::Errors::DisallowedNameError (class)">DisallowedNameError</a></span>, <span class='object_link'><a href="DisallowedSharedLinkPolicyError.html" title="DropboxApi::Errors::DisallowedSharedLinkPolicyError (class)">DisallowedSharedLinkPolicyError</a></span>, <span class='object_link'><a href="DownloadError.html" title="DropboxApi::Errors::DownloadError (class)">DownloadError</a></span>, <span class='object_link'><a href="DownloadFailedError.html" title="DropboxApi::Errors::DownloadFailedError (class)">DownloadFailedError</a></span>, <span class='object_link'><a href="EmailUnverifiedError.html" title="DropboxApi::Errors::EmailUnverifiedError (class)">EmailUnverifiedError</a></span>, <span class='object_link'><a href="ExpiredAccessTokenError.html" title="DropboxApi::Errors::ExpiredAccessTokenError (class)">ExpiredAccessTokenError</a></span>, <span class='object_link'><a href="FileAncestorConflictError.html" title="DropboxApi::Errors::FileAncestorConflictError (class)">FileAncestorConflictError</a></span>, <span class='object_link'><a href="FileConflictError.html" title="DropboxApi::Errors::FileConflictError (class)">FileConflictError</a></span>, <span class='object_link'><a href="FileMemberActionError.html" title="DropboxApi::Errors::FileMemberActionError (class)">FileMemberActionError</a></span>, <span class='object_link'><a href="FolderConflictError.html" title="DropboxApi::Errors::FolderConflictError (class)">FolderConflictError</a></span>, <span class='object_link'><a href="GetAccountError.html" title="DropboxApi::Errors::GetAccountError (class)">GetAccountError</a></span>, <span class='object_link'><a href="GetCopyReferenceError.html" title="DropboxApi::Errors::GetCopyReferenceError (class)">GetCopyReferenceError</a></span>, <span class='object_link'><a href="GetMetadataError.html" title="DropboxApi::Errors::GetMetadataError (class)">GetMetadataError</a></span>, <span class='object_link'><a href="GroupDeletedError.html" title="DropboxApi::Errors::GroupDeletedError (class)">GroupDeletedError</a></span>, <span class='object_link'><a href="GroupNotOnTeamError.html" title="DropboxApi::Errors::GroupNotOnTeamError (class)">GroupNotOnTeamError</a></span>, <span class='object_link'><a href="InProgressError.html" title="DropboxApi::Errors::InProgressError (class)">InProgressError</a></span>, <span class='object_link'><a href="InsideAppFolderError.html" title="DropboxApi::Errors::InsideAppFolderError (class)">InsideAppFolderError</a></span>, <span class='object_link'><a href="InsideOsxPackageError.html" title="DropboxApi::Errors::InsideOsxPackageError (class)">InsideOsxPackageError</a></span>, <span class='object_link'><a href="InsidePublicFolderError.html" title="DropboxApi::Errors::InsidePublicFolderError (class)">InsidePublicFolderError</a></span>, <span class='object_link'><a href="InsideSharedFolderError.html" title="DropboxApi::Errors::InsideSharedFolderError (class)">InsideSharedFolderError</a></span>, <span class='object_link'><a href="InsufficientPlanError.html" title="DropboxApi::Errors::InsufficientPlanError (class)">InsufficientPlanError</a></span>, <span class='object_link'><a href="InsufficientSpaceError.html" title="DropboxApi::Errors::InsufficientSpaceError (class)">InsufficientSpaceError</a></span>, <span class='object_link'><a href="InternalError.html" title="DropboxApi::Errors::InternalError (class)">InternalError</a></span>, <span class='object_link'><a href="InvalidCommentError.html" title="DropboxApi::Errors::InvalidCommentError (class)">InvalidCommentError</a></span>, <span class='object_link'><a href="InvalidCopyReferenceError.html" title="DropboxApi::Errors::InvalidCopyReferenceError (class)">InvalidCopyReferenceError</a></span>, <span class='object_link'><a href="InvalidCursorError.html" title="DropboxApi::Errors::InvalidCursorError (class)">InvalidCursorError</a></span>, <span class='object_link'><a href="InvalidDropboxIdError.html" title="DropboxApi::Errors::InvalidDropboxIdError (class)">InvalidDropboxIdError</a></span>, <span class='object_link'><a href="InvalidEmailError.html" title="DropboxApi::Errors::InvalidEmailError (class)">InvalidEmailError</a></span>, <span class='object_link'><a href="InvalidFileError.html" title="DropboxApi::Errors::InvalidFileError (class)">InvalidFileError</a></span>, <span class='object_link'><a href="InvalidIdError.html" title="DropboxApi::Errors::InvalidIdError (class)">InvalidIdError</a></span>, <span class='object_link'><a href="InvalidMemberError.html" title="DropboxApi::Errors::InvalidMemberError (class)">InvalidMemberError</a></span>, <span class='object_link'><a href="InvalidPathError.html" title="DropboxApi::Errors::InvalidPathError (class)">InvalidPathError</a></span>, <span class='object_link'><a href="InvalidRevisionError.html" title="DropboxApi::Errors::InvalidRevisionError (class)">InvalidRevisionError</a></span>, <span class='object_link'><a href="InvalidSettingsError.html" title="DropboxApi::Errors::InvalidSettingsError (class)">InvalidSettingsError</a></span>, <span class='object_link'><a href="InvalidUrlError.html" title="DropboxApi::Errors::InvalidUrlError (class)">InvalidUrlError</a></span>, <span class='object_link'><a href="IsAppFolderError.html" title="DropboxApi::Errors::IsAppFolderError (class)">IsAppFolderError</a></span>, <span class='object_link'><a href="IsFileError.html" title="DropboxApi::Errors::IsFileError (class)">IsFileError</a></span>, <span class='object_link'><a href="IsFolderError.html" title="DropboxApi::Errors::IsFolderError (class)">IsFolderError</a></span>, <span class='object_link'><a href="IsOsxPackageError.html" title="DropboxApi::Errors::IsOsxPackageError (class)">IsOsxPackageError</a></span>, <span class='object_link'><a href="IsPublicFolderError.html" title="DropboxApi::Errors::IsPublicFolderError (class)">IsPublicFolderError</a></span>, <span class='object_link'><a href="ListFolderContinueError.html" title="DropboxApi::Errors::ListFolderContinueError (class)">ListFolderContinueError</a></span>, <span class='object_link'><a href="ListFolderError.html" title="DropboxApi::Errors::ListFolderError (class)">ListFolderError</a></span>, <span class='object_link'><a href="ListFolderLongpollError.html" title="DropboxApi::Errors::ListFolderLongpollError (class)">ListFolderLongpollError</a></span>, <span class='object_link'><a href="ListRevisionsError.html" title="DropboxApi::Errors::ListRevisionsError (class)">ListRevisionsError</a></span>, <span class='object_link'><a href="ListSharedLinksError.html" title="DropboxApi::Errors::ListSharedLinksError (class)">ListSharedLinksError</a></span>, <span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span>, <span class='object_link'><a href="MalformedPathError.html" title="DropboxApi::Errors::MalformedPathError (class)">MalformedPathError</a></span>, <span class='object_link'><a href="NoAccountError.html" title="DropboxApi::Errors::NoAccountError (class)">NoAccountError</a></span>, <span class='object_link'><a href="NoPermissionError.html" title="DropboxApi::Errors::NoPermissionError (class)">NoPermissionError</a></span>, <span class='object_link'><a href="NoWritePermissionError.html" title="DropboxApi::Errors::NoWritePermissionError (class)">NoWritePermissionError</a></span>, <span class='object_link'><a href="NotAMemberError.html" title="DropboxApi::Errors::NotAMemberError (class)">NotAMemberError</a></span>, <span class='object_link'><a href="NotFileError.html" title="DropboxApi::Errors::NotFileError (class)">NotFileError</a></span>, <span class='object_link'><a href="NotFolderError.html" title="DropboxApi::Errors::NotFolderError (class)">NotFolderError</a></span>, <span class='object_link'><a href="NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span>, <span class='object_link'><a href="PollError.html" title="DropboxApi::Errors::PollError (class)">PollError</a></span>, <span class='object_link'><a href="PreviewError.html" title="DropboxApi::Errors::PreviewError (class)">PreviewError</a></span>, <span class='object_link'><a href="RateLimitError.html" title="DropboxApi::Errors::RateLimitError (class)">RateLimitError</a></span>, <span class='object_link'><a href="RelocationBatchEntryError.html" title="DropboxApi::Errors::RelocationBatchEntryError (class)">RelocationBatchEntryError</a></span>, <span class='object_link'><a href="RelocationError.html" title="DropboxApi::Errors::RelocationError (class)">RelocationError</a></span>, <span class='object_link'><a href="RestoreError.html" title="DropboxApi::Errors::RestoreError (class)">RestoreError</a></span>, <span class='object_link'><a href="RestrictedContentError.html" title="DropboxApi::Errors::RestrictedContentError (class)">RestrictedContentError</a></span>, <span class='object_link'><a href="RevokeSharedLinkError.html" title="DropboxApi::Errors::RevokeSharedLinkError (class)">RevokeSharedLinkError</a></span>, <span class='object_link'><a href="SaveCopyReferenceError.html" title="DropboxApi::Errors::SaveCopyReferenceError (class)">SaveCopyReferenceError</a></span>, <span class='object_link'><a href="SaveUrlError.html" title="DropboxApi::Errors::SaveUrlError (class)">SaveUrlError</a></span>, <span class='object_link'><a href="SearchError.html" title="DropboxApi::Errors::SearchError (class)">SearchError</a></span>, <span class='object_link'><a href="SettingsError.html" title="DropboxApi::Errors::SettingsError (class)">SettingsError</a></span>, <span class='object_link'><a href="ShareFolderError.html" title="DropboxApi::Errors::ShareFolderError (class)">ShareFolderError</a></span>, <span class='object_link'><a href="SharePathError.html" title="DropboxApi::Errors::SharePathError (class)">SharePathError</a></span>, <span class='object_link'><a href="SharedFolderAccessError.html" title="DropboxApi::Errors::SharedFolderAccessError (class)">SharedFolderAccessError</a></span>, <span class='object_link'><a href="SharedLinkAccessDeniedError.html" title="DropboxApi::Errors::SharedLinkAccessDeniedError (class)">SharedLinkAccessDeniedError</a></span>, <span class='object_link'><a href="SharedLinkAlreadyExistsError.html" title="DropboxApi::Errors::SharedLinkAlreadyExistsError (class)">SharedLinkAlreadyExistsError</a></span>, <span class='object_link'><a href="SharedLinkError.html" title="DropboxApi::Errors::SharedLinkError (class)">SharedLinkError</a></span>, <span class='object_link'><a href="SharedLinkMalformedError.html" title="DropboxApi::Errors::SharedLinkMalformedError (class)">SharedLinkMalformedError</a></span>, <span class='object_link'><a href="SharedLinkNotFoundError.html" title="DropboxApi::Errors::SharedLinkNotFoundError (class)">SharedLinkNotFoundError</a></span>, <span class='object_link'><a href="SharingFileAccessError.html" title="DropboxApi::Errors::SharingFileAccessError (class)">SharingFileAccessError</a></span>, <span class='object_link'><a href="SharingUserError.html" title="DropboxApi::Errors::SharingUserError (class)">SharingUserError</a></span>, <span class='object_link'><a href="TeamFolderError.html" title="DropboxApi::Errors::TeamFolderError (class)">TeamFolderError</a></span>, <span class='object_link'><a href="TeamPolicyDisallowsMemberPolicyError.html" title="DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError (class)">TeamPolicyDisallowsMemberPolicyError</a></span>, <span class='object_link'><a href="ThumbnailBatchError.html" title="DropboxApi::Errors::ThumbnailBatchError (class)">ThumbnailBatchError</a></span>, <span class='object_link'><a href="ThumbnailError.html" title="DropboxApi::Errors::ThumbnailError (class)">ThumbnailError</a></span>, <span class='object_link'><a href="TooManyFilesError.html" title="DropboxApi::Errors::TooManyFilesError (class)">TooManyFilesError</a></span>, <span class='object_link'><a href="TooManyMembersError.html" title="DropboxApi::Errors::TooManyMembersError (class)">TooManyMembersError</a></span>, <span class='object_link'><a href="TooManyPendingInvitesError.html" title="DropboxApi::Errors::TooManyPendingInvitesError (class)">TooManyPendingInvitesError</a></span>, <span class='object_link'><a href="TooManyRequestsError.html" title="DropboxApi::Errors::TooManyRequestsError (class)">TooManyRequestsError</a></span>, <span class='object_link'><a href="TooManySharedFolderTargetsError.html" title="DropboxApi::Errors::TooManySharedFolderTargetsError (class)">TooManySharedFolderTargetsError</a></span>, <span class='object_link'><a href="UnmountedError.html" title="DropboxApi::Errors::UnmountedError (class)">UnmountedError</a></span>, <span class='object_link'><a href="UnshareFileError.html" title="DropboxApi::Errors::UnshareFileError (class)">UnshareFileError</a></span>, <span class='object_link'><a href="UnsupportedContentError.html" title="DropboxApi::Errors::UnsupportedContentError (class)">UnsupportedContentError</a></span>, <span class='object_link'><a href="UnsupportedExtensionError.html" title="DropboxApi::Errors::UnsupportedExtensionError (class)">UnsupportedExtensionError</a></span>, <span class='object_link'><a href="UnsupportedImageError.html" title="DropboxApi::Errors::UnsupportedImageError (class)">UnsupportedImageError</a></span>, <span class='object_link'><a href="UnsupportedLinkTypeError.html" title="DropboxApi::Errors::UnsupportedLinkTypeError (class)">UnsupportedLinkTypeError</a></span>, <span class='object_link'><a href="UnverifiedDropboxId.html" title="DropboxApi::Errors::UnverifiedDropboxId (class)">UnverifiedDropboxId</a></span>, <span class='object_link'><a href="UploadError.html" title="DropboxApi::Errors::UploadError (class)">UploadError</a></span>, <span class='object_link'><a href="UploadSessionFinishError.html" title="DropboxApi::Errors::UploadSessionFinishError (class)">UploadSessionFinishError</a></span>, <span class='object_link'><a href="UploadSessionLookupError.html" title="DropboxApi::Errors::UploadSessionLookupError (class)">UploadSessionLookupError</a></span>, <span class='object_link'><a href="UploadSessionOffsetError.html" title="DropboxApi::Errors::UploadSessionOffsetError (class)">UploadSessionOffsetError</a></span>, <span class='object_link'><a href="UploadWriteFailedError.html" title="DropboxApi::Errors::UploadWriteFailedError (class)">UploadWriteFailedError</a></span>, <span class='object_link'><a href="WriteConflictError.html" title="DropboxApi::Errors::WriteConflictError (class)">WriteConflictError</a></span>, <span class='object_link'><a href="WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span></p>
+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build-class_method" title="build (class method)">.<strong>build</strong>(message, metadata)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#find_subtype-class_method" title="find_subtype (class method)">.<strong>find_subtype</strong>(metadata)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(message, metadata)  &#x21d2; BasicError </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of BasicError.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(message, metadata)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of BasicError.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/errors/basic_error.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_message'>message</span><span +class='comma'>,</span> <span class='id identifier +rubyid_metadata'>metadata</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@metadata</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span>
+<span class='kw'>super</span> <span class='id identifier rubyid_message'>message</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build-class_method">
+
+  .<strong>build</strong>(message, metadata)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

10 11 12 13 14 15 16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/errors/basic_error.rb', line 10</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build'>build</span><span +class='lparen'>(</span><span class='id identifier +rubyid_message'>message</span><span +class='comma'>,</span> <span class='id identifier +rubyid_metadata'>metadata</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_subtype'>subtype</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='op'>=</span> <span class='id identifier rubyid_find_subtype'>find_subtype</span> <span class='id identifier rubyid_metadata'>metadata</span>
+
+<span class='kw'>if</span> <span class='id identifier rubyid_subtype'>subtype</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_subtype'>subtype</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="find_subtype-class_method">
+
+  .<strong>find_subtype</strong>(metadata)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

20 21 22 23 24 25 26 27 28</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/errors/basic_error.rb', line 20</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_find_subtype'>find_subtype</span><span +class='lparen'>(</span><span class='id identifier +rubyid_metadata'>metadata</span><span +class='rparen'>)</span>

+ +
<span class='kw'>if</span> <span class='kw'>defined?</span> <span class='kw'>self</span><span class='op'>::</span><span class='const'>ErrorSubtypes</span>
+  <span class='id identifier rubyid_discriminator'>discriminator</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_metadata'>metadata</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='lbracket'>[</span><span class='id identifier rubyid_discriminator'>discriminator</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='lbracket'>[</span><span class='id identifier rubyid_discriminator'>discriminator</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='lbracket'>[</span><span class='kw'>self</span><span class='op'>::</span><span class='const'>ErrorSubtypes</span><span class='lbracket'>[</span><span class='id identifier rubyid_discriminator'>discriminator</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='rbracket'>]</span>
+<span class='kw'>else</span>
+  <span class='lbracket'>[</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='rbracket'>]</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/CantCopySharedFolderError_html.html b/doc/docs/DropboxApi/Errors/CantCopySharedFolderError_html.html new file mode 100644 index 00000000..95cd6325 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/CantCopySharedFolderError_html.html @@ -0,0 +1,822 @@ + + + + + + +CantCopySharedFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::CantCopySharedFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::CantCopySharedFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">CantCopySharedFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::CantCopySharedFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::CantCopySharedFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError_html.html b/doc/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError_html.html new file mode 100644 index 00000000..c9c76a48 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError_html.html @@ -0,0 +1,822 @@ + + + + + + +CantMoveFolderIntoItselfError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::CantMoveFolderIntoItselfError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::CantMoveFolderIntoItselfError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">CantMoveFolderIntoItselfError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::CantMoveFolderIntoItselfError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::CantMoveFolderIntoItselfError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/CantNestSharedFolderError_html.html b/doc/docs/DropboxApi/Errors/CantNestSharedFolderError_html.html new file mode 100644 index 00000000..b6ff22af --- /dev/null +++ b/doc/docs/DropboxApi/Errors/CantNestSharedFolderError_html.html @@ -0,0 +1,822 @@ + + + + + + +CantNestSharedFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::CantNestSharedFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::CantNestSharedFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">CantNestSharedFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::CantNestSharedFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::CantNestSharedFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/CantShareOutsideTeamError_html.html b/doc/docs/DropboxApi/Errors/CantShareOutsideTeamError_html.html new file mode 100644 index 00000000..3530e471 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/CantShareOutsideTeamError_html.html @@ -0,0 +1,822 @@ + + + + + + +CantShareOutsideTeamError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::CantShareOutsideTeamError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::CantShareOutsideTeamError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">CantShareOutsideTeamError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::CantShareOutsideTeamError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::CantShareOutsideTeamError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/ContainsSharedFolderError_html.html b/doc/docs/DropboxApi/Errors/ContainsSharedFolderError_html.html new file mode 100644 index 00000000..dbec2505 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/ContainsSharedFolderError_html.html @@ -0,0 +1,822 @@ + + + + + + +ContainsSharedFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::ContainsSharedFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::ContainsSharedFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">ContainsSharedFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::ContainsSharedFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::ContainsSharedFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/ConversionError_html.html b/doc/docs/DropboxApi/Errors/ConversionError_html.html new file mode 100644 index 00000000..7d34c400 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/ConversionError_html.html @@ -0,0 +1,822 @@ + + + + + + +ConversionError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::ConversionError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::ConversionError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">ConversionError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::ConversionError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::ConversionError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/CreateFileRequestError_html.html b/doc/docs/DropboxApi/Errors/CreateFileRequestError_html.html new file mode 100644 index 00000000..f586da70 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/CreateFileRequestError_html.html @@ -0,0 +1,840 @@ + + + + + + +CreateFileRequestError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::CreateFileRequestError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::CreateFileRequestError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">CreateFileRequestError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::CreateFileRequestError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::CreateFileRequestError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/create_file_request_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>
+  Constant Summary
+  <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+</h2>
+
+<dl class="constants">
+
+    <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+    </dt>
+    <dd><pre class="code"><span class='lbrace'>{</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/CreateFolderBatchError_html.html b/doc/docs/DropboxApi/Errors/CreateFolderBatchError_html.html new file mode 100644 index 00000000..343383d6 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/CreateFolderBatchError_html.html @@ -0,0 +1,841 @@ + + + + + + +CreateFolderBatchError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::CreateFolderBatchError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::CreateFolderBatchError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">CreateFolderBatchError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::CreateFolderBatchError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::CreateFolderBatchError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/create_folder_batch_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>too_many_files:</span> <span class='const'><span class='object_link'><a href="TooManyFilesError.html" title="DropboxApi::Errors::TooManyFilesError (class)">TooManyFilesError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/CreateFolderError_html.html b/doc/docs/DropboxApi/Errors/CreateFolderError_html.html new file mode 100644 index 00000000..67f050fa --- /dev/null +++ b/doc/docs/DropboxApi/Errors/CreateFolderError_html.html @@ -0,0 +1,841 @@ + + + + + + +CreateFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::CreateFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::CreateFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">CreateFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::CreateFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::CreateFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/create_folder_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError_html.html b/doc/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError_html.html new file mode 100644 index 00000000..71e63e30 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError_html.html @@ -0,0 +1,845 @@ + + + + + + +CreateSharedLinkWithSettingsError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::CreateSharedLinkWithSettingsError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::CreateSharedLinkWithSettingsError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">CreateSharedLinkWithSettingsError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::CreateSharedLinkWithSettingsError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::CreateSharedLinkWithSettingsError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/create_shared_link_with_settings_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span><span class='comma'>,</span>
+<span class='label'>email_not_verified:</span> <span class='const'><span class='object_link'><a href="EmailUnverifiedError.html" title="DropboxApi::Errors::EmailUnverifiedError (class)">EmailUnverifiedError</a></span></span><span class='comma'>,</span>
+<span class='label'>shared_link_already_exists:</span> <span class='const'><span class='object_link'><a href="SharedLinkAlreadyExistsError.html" title="DropboxApi::Errors::SharedLinkAlreadyExistsError (class)">SharedLinkAlreadyExistsError</a></span></span><span class='comma'>,</span>
+<span class='label'>settings_error:</span> <span class='const'><span class='object_link'><a href="SettingsError.html" title="DropboxApi::Errors::SettingsError (class)">SettingsError</a></span></span><span class='comma'>,</span>
+<span class='label'>access_denied:</span> <span class='const'><span class='object_link'><a href="NoPermissionError.html" title="DropboxApi::Errors::NoPermissionError (class)">NoPermissionError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/CursorClosedError_html.html b/doc/docs/DropboxApi/Errors/CursorClosedError_html.html new file mode 100644 index 00000000..265d7e2d --- /dev/null +++ b/doc/docs/DropboxApi/Errors/CursorClosedError_html.html @@ -0,0 +1,822 @@ + + + + + + +CursorClosedError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::CursorClosedError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::CursorClosedError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">CursorClosedError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::CursorClosedError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::CursorClosedError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/CursorNotClosedError_html.html b/doc/docs/DropboxApi/Errors/CursorNotClosedError_html.html new file mode 100644 index 00000000..07bdc062 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/CursorNotClosedError_html.html @@ -0,0 +1,822 @@ + + + + + + +CursorNotClosedError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::CursorNotClosedError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::CursorNotClosedError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">CursorNotClosedError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::CursorNotClosedError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::CursorNotClosedError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/DeleteError_html.html b/doc/docs/DropboxApi/Errors/DeleteError_html.html new file mode 100644 index 00000000..bb018d63 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/DeleteError_html.html @@ -0,0 +1,843 @@ + + + + + + +DeleteError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::DeleteError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::DeleteError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">DeleteError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::DeleteError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::DeleteError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/delete_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path_lookup:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span><span class='comma'>,</span>
+<span class='label'>path_write:</span> <span class='const'><span class='object_link'><a href="WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span></span><span class='comma'>,</span>
+<span class='label'>too_many_write_operations:</span> <span class='const'><span class='object_link'><a href="TooManyWriteOperationsError.html" title="DropboxApi::Errors::TooManyWriteOperationsError (class)">TooManyWriteOperationsError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/DisallowedNameError_html.html b/doc/docs/DropboxApi/Errors/DisallowedNameError_html.html new file mode 100644 index 00000000..da0e6648 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/DisallowedNameError_html.html @@ -0,0 +1,822 @@ + + + + + + +DisallowedNameError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::DisallowedNameError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::DisallowedNameError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">DisallowedNameError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::DisallowedNameError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::DisallowedNameError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError_html.html b/doc/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError_html.html new file mode 100644 index 00000000..3f8a48b5 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError_html.html @@ -0,0 +1,822 @@ + + + + + + +DisallowedSharedLinkPolicyError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::DisallowedSharedLinkPolicyError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::DisallowedSharedLinkPolicyError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">DisallowedSharedLinkPolicyError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::DisallowedSharedLinkPolicyError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::DisallowedSharedLinkPolicyError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/DownloadError_html.html b/doc/docs/DropboxApi/Errors/DownloadError_html.html new file mode 100644 index 00000000..7f058f67 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/DownloadError_html.html @@ -0,0 +1,841 @@ + + + + + + +DownloadError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::DownloadError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::DownloadError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">DownloadError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::DownloadError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::DownloadError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/download_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/DownloadFailedError_html.html b/doc/docs/DropboxApi/Errors/DownloadFailedError_html.html new file mode 100644 index 00000000..e376be3d --- /dev/null +++ b/doc/docs/DropboxApi/Errors/DownloadFailedError_html.html @@ -0,0 +1,822 @@ + + + + + + +DownloadFailedError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::DownloadFailedError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::DownloadFailedError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">DownloadFailedError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::DownloadFailedError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::DownloadFailedError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/EmailUnverifiedError_html.html b/doc/docs/DropboxApi/Errors/EmailUnverifiedError_html.html new file mode 100644 index 00000000..12123a95 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/EmailUnverifiedError_html.html @@ -0,0 +1,822 @@ + + + + + + +EmailUnverifiedError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::EmailUnverifiedError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::EmailUnverifiedError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (E)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">EmailUnverifiedError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::EmailUnverifiedError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::EmailUnverifiedError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/ExpiredAccessTokenError_html.html b/doc/docs/DropboxApi/Errors/ExpiredAccessTokenError_html.html new file mode 100644 index 00000000..4e707396 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/ExpiredAccessTokenError_html.html @@ -0,0 +1,822 @@ + + + + + + +ExpiredAccessTokenError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::ExpiredAccessTokenError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::ExpiredAccessTokenError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (E)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">ExpiredAccessTokenError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::ExpiredAccessTokenError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::ExpiredAccessTokenError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/expired_access_token_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/FileAncestorConflictError_html.html b/doc/docs/DropboxApi/Errors/FileAncestorConflictError_html.html new file mode 100644 index 00000000..6748e34a --- /dev/null +++ b/doc/docs/DropboxApi/Errors/FileAncestorConflictError_html.html @@ -0,0 +1,822 @@ + + + + + + +FileAncestorConflictError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::FileAncestorConflictError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::FileAncestorConflictError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">FileAncestorConflictError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::FileAncestorConflictError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::FileAncestorConflictError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/FileConflictError_html.html b/doc/docs/DropboxApi/Errors/FileConflictError_html.html new file mode 100644 index 00000000..9c18af1f --- /dev/null +++ b/doc/docs/DropboxApi/Errors/FileConflictError_html.html @@ -0,0 +1,822 @@ + + + + + + +FileConflictError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::FileConflictError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::FileConflictError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">FileConflictError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::FileConflictError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::FileConflictError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/FileMemberActionError_html.html b/doc/docs/DropboxApi/Errors/FileMemberActionError_html.html new file mode 100644 index 00000000..c16032e3 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/FileMemberActionError_html.html @@ -0,0 +1,844 @@ + + + + + + +FileMemberActionError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::FileMemberActionError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::FileMemberActionError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">FileMemberActionError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::FileMemberActionError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::FileMemberActionError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/file_member_action_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>invalid_member:</span> <span class='const'><span class='object_link'><a href="InvalidMemberError.html" title="DropboxApi::Errors::InvalidMemberError (class)">InvalidMemberError</a></span></span><span class='comma'>,</span>
+<span class='label'>no_permission:</span> <span class='const'><span class='object_link'><a href="NoPermissionError.html" title="DropboxApi::Errors::NoPermissionError (class)">NoPermissionError</a></span></span><span class='comma'>,</span>
+<span class='label'>access_error:</span> <span class='const'><span class='object_link'><a href="SharingFileAccessError.html" title="DropboxApi::Errors::SharingFileAccessError (class)">SharingFileAccessError</a></span></span><span class='comma'>,</span>
+<span class='label'>no_explicit_access:</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/ParentFolderAccessInfo.html" title="DropboxApi::Metadata::ParentFolderAccessInfo (class)">ParentFolderAccessInfo</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/FolderConflictError_html.html b/doc/docs/DropboxApi/Errors/FolderConflictError_html.html new file mode 100644 index 00000000..9cc66c34 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/FolderConflictError_html.html @@ -0,0 +1,822 @@ + + + + + + +FolderConflictError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::FolderConflictError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::FolderConflictError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">FolderConflictError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::FolderConflictError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::FolderConflictError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/GetAccountError_html.html b/doc/docs/DropboxApi/Errors/GetAccountError_html.html new file mode 100644 index 00000000..592ef2da --- /dev/null +++ b/doc/docs/DropboxApi/Errors/GetAccountError_html.html @@ -0,0 +1,841 @@ + + + + + + +GetAccountError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::GetAccountError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::GetAccountError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">GetAccountError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::GetAccountError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::GetAccountError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/get_account_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>no_account:</span> <span class='const'><span class='object_link'><a href="NoAccountError.html" title="DropboxApi::Errors::NoAccountError (class)">NoAccountError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/GetCopyReferenceError_html.html b/doc/docs/DropboxApi/Errors/GetCopyReferenceError_html.html new file mode 100644 index 00000000..3625c0dd --- /dev/null +++ b/doc/docs/DropboxApi/Errors/GetCopyReferenceError_html.html @@ -0,0 +1,841 @@ + + + + + + +GetCopyReferenceError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::GetCopyReferenceError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::GetCopyReferenceError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">GetCopyReferenceError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::GetCopyReferenceError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::GetCopyReferenceError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/get_copy_reference_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/GetMetadataError_html.html b/doc/docs/DropboxApi/Errors/GetMetadataError_html.html new file mode 100644 index 00000000..0a884e1b --- /dev/null +++ b/doc/docs/DropboxApi/Errors/GetMetadataError_html.html @@ -0,0 +1,841 @@ + + + + + + +GetMetadataError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::GetMetadataError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::GetMetadataError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">GetMetadataError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::GetMetadataError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::GetMetadataError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/get_metadata_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/GroupDeletedError_html.html b/doc/docs/DropboxApi/Errors/GroupDeletedError_html.html new file mode 100644 index 00000000..a0dc89aa --- /dev/null +++ b/doc/docs/DropboxApi/Errors/GroupDeletedError_html.html @@ -0,0 +1,822 @@ + + + + + + +GroupDeletedError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::GroupDeletedError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::GroupDeletedError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">GroupDeletedError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::GroupDeletedError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::GroupDeletedError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/GroupNotOnTeamError_html.html b/doc/docs/DropboxApi/Errors/GroupNotOnTeamError_html.html new file mode 100644 index 00000000..7012d6ab --- /dev/null +++ b/doc/docs/DropboxApi/Errors/GroupNotOnTeamError_html.html @@ -0,0 +1,822 @@ + + + + + + +GroupNotOnTeamError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::GroupNotOnTeamError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::GroupNotOnTeamError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">GroupNotOnTeamError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::GroupNotOnTeamError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::GroupNotOnTeamError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/HttpError_html.html b/doc/docs/DropboxApi/Errors/HttpError_html.html new file mode 100644 index 00000000..a597dd9f --- /dev/null +++ b/doc/docs/DropboxApi/Errors/HttpError_html.html @@ -0,0 +1,808 @@ + + + + + + +HttpError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::HttpError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::HttpError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (H)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">HttpError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::HttpError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">StandardError</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next">DropboxApi::Errors::HttpError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/http_error.rb</dd>
+</dl>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InProgressError_html.html b/doc/docs/DropboxApi/Errors/InProgressError_html.html new file mode 100644 index 00000000..947f2f14 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InProgressError_html.html @@ -0,0 +1,822 @@ + + + + + + +InProgressError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InProgressError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InProgressError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InProgressError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InProgressError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InProgressError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InsideAppFolderError_html.html b/doc/docs/DropboxApi/Errors/InsideAppFolderError_html.html new file mode 100644 index 00000000..72ce5eaf --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InsideAppFolderError_html.html @@ -0,0 +1,822 @@ + + + + + + +InsideAppFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InsideAppFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InsideAppFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InsideAppFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InsideAppFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InsideAppFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InsideOsxPackageError_html.html b/doc/docs/DropboxApi/Errors/InsideOsxPackageError_html.html new file mode 100644 index 00000000..89111d87 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InsideOsxPackageError_html.html @@ -0,0 +1,822 @@ + + + + + + +InsideOsxPackageError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InsideOsxPackageError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InsideOsxPackageError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InsideOsxPackageError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InsideOsxPackageError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InsideOsxPackageError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InsidePublicFolderError_html.html b/doc/docs/DropboxApi/Errors/InsidePublicFolderError_html.html new file mode 100644 index 00000000..a5661fe8 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InsidePublicFolderError_html.html @@ -0,0 +1,822 @@ + + + + + + +InsidePublicFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InsidePublicFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InsidePublicFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InsidePublicFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InsidePublicFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InsidePublicFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InsideSharedFolderError_html.html b/doc/docs/DropboxApi/Errors/InsideSharedFolderError_html.html new file mode 100644 index 00000000..9943b898 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InsideSharedFolderError_html.html @@ -0,0 +1,822 @@ + + + + + + +InsideSharedFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InsideSharedFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InsideSharedFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InsideSharedFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InsideSharedFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InsideSharedFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InsufficientPlanError_html.html b/doc/docs/DropboxApi/Errors/InsufficientPlanError_html.html new file mode 100644 index 00000000..ecfedb44 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InsufficientPlanError_html.html @@ -0,0 +1,822 @@ + + + + + + +InsufficientPlanError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InsufficientPlanError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InsufficientPlanError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InsufficientPlanError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InsufficientPlanError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InsufficientPlanError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InsufficientSpaceError_html.html b/doc/docs/DropboxApi/Errors/InsufficientSpaceError_html.html new file mode 100644 index 00000000..4550bd56 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InsufficientSpaceError_html.html @@ -0,0 +1,822 @@ + + + + + + +InsufficientSpaceError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InsufficientSpaceError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InsufficientSpaceError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InsufficientSpaceError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InsufficientSpaceError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InsufficientSpaceError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InternalError_html.html b/doc/docs/DropboxApi/Errors/InternalError_html.html new file mode 100644 index 00000000..d6b43442 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InternalError_html.html @@ -0,0 +1,822 @@ + + + + + + +InternalError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InternalError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InternalError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InternalError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InternalError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InternalError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InvalidCommentError_html.html b/doc/docs/DropboxApi/Errors/InvalidCommentError_html.html new file mode 100644 index 00000000..6d1e7025 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InvalidCommentError_html.html @@ -0,0 +1,822 @@ + + + + + + +InvalidCommentError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InvalidCommentError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InvalidCommentError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InvalidCommentError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InvalidCommentError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InvalidCommentError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InvalidCopyReferenceError_html.html b/doc/docs/DropboxApi/Errors/InvalidCopyReferenceError_html.html new file mode 100644 index 00000000..a16953dd --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InvalidCopyReferenceError_html.html @@ -0,0 +1,822 @@ + + + + + + +InvalidCopyReferenceError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InvalidCopyReferenceError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InvalidCopyReferenceError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InvalidCopyReferenceError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InvalidCopyReferenceError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InvalidCopyReferenceError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InvalidCursorError_html.html b/doc/docs/DropboxApi/Errors/InvalidCursorError_html.html new file mode 100644 index 00000000..11490a71 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InvalidCursorError_html.html @@ -0,0 +1,822 @@ + + + + + + +InvalidCursorError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InvalidCursorError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InvalidCursorError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InvalidCursorError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InvalidCursorError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InvalidCursorError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InvalidDropboxIdError_html.html b/doc/docs/DropboxApi/Errors/InvalidDropboxIdError_html.html new file mode 100644 index 00000000..e8cc20a9 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InvalidDropboxIdError_html.html @@ -0,0 +1,822 @@ + + + + + + +InvalidDropboxIdError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InvalidDropboxIdError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InvalidDropboxIdError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InvalidDropboxIdError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InvalidDropboxIdError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InvalidDropboxIdError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InvalidEmailError_html.html b/doc/docs/DropboxApi/Errors/InvalidEmailError_html.html new file mode 100644 index 00000000..bb884c51 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InvalidEmailError_html.html @@ -0,0 +1,822 @@ + + + + + + +InvalidEmailError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InvalidEmailError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InvalidEmailError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InvalidEmailError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InvalidEmailError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InvalidEmailError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InvalidFileError_html.html b/doc/docs/DropboxApi/Errors/InvalidFileError_html.html new file mode 100644 index 00000000..b7db1940 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InvalidFileError_html.html @@ -0,0 +1,822 @@ + + + + + + +InvalidFileError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InvalidFileError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InvalidFileError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InvalidFileError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InvalidFileError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InvalidFileError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InvalidIdError_html.html b/doc/docs/DropboxApi/Errors/InvalidIdError_html.html new file mode 100644 index 00000000..cbd2cc37 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InvalidIdError_html.html @@ -0,0 +1,822 @@ + + + + + + +InvalidIdError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InvalidIdError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InvalidIdError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InvalidIdError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InvalidIdError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InvalidIdError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InvalidMemberError_html.html b/doc/docs/DropboxApi/Errors/InvalidMemberError_html.html new file mode 100644 index 00000000..d1dc7714 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InvalidMemberError_html.html @@ -0,0 +1,822 @@ + + + + + + +InvalidMemberError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InvalidMemberError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InvalidMemberError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InvalidMemberError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InvalidMemberError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InvalidMemberError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InvalidPathError_html.html b/doc/docs/DropboxApi/Errors/InvalidPathError_html.html new file mode 100644 index 00000000..98e8662d --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InvalidPathError_html.html @@ -0,0 +1,822 @@ + + + + + + +InvalidPathError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InvalidPathError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InvalidPathError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InvalidPathError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InvalidPathError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InvalidPathError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InvalidRevisionError_html.html b/doc/docs/DropboxApi/Errors/InvalidRevisionError_html.html new file mode 100644 index 00000000..16786370 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InvalidRevisionError_html.html @@ -0,0 +1,822 @@ + + + + + + +InvalidRevisionError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InvalidRevisionError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InvalidRevisionError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InvalidRevisionError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InvalidRevisionError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InvalidRevisionError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InvalidSettingsError_html.html b/doc/docs/DropboxApi/Errors/InvalidSettingsError_html.html new file mode 100644 index 00000000..504161c4 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InvalidSettingsError_html.html @@ -0,0 +1,822 @@ + + + + + + +InvalidSettingsError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InvalidSettingsError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InvalidSettingsError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InvalidSettingsError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InvalidSettingsError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InvalidSettingsError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/InvalidUrlError_html.html b/doc/docs/DropboxApi/Errors/InvalidUrlError_html.html new file mode 100644 index 00000000..d36ed7a2 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/InvalidUrlError_html.html @@ -0,0 +1,822 @@ + + + + + + +InvalidUrlError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::InvalidUrlError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::InvalidUrlError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">InvalidUrlError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::InvalidUrlError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::InvalidUrlError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/IsAppFolderError_html.html b/doc/docs/DropboxApi/Errors/IsAppFolderError_html.html new file mode 100644 index 00000000..a2b87e9f --- /dev/null +++ b/doc/docs/DropboxApi/Errors/IsAppFolderError_html.html @@ -0,0 +1,822 @@ + + + + + + +IsAppFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::IsAppFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::IsAppFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">IsAppFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::IsAppFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::IsAppFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/IsFileError_html.html b/doc/docs/DropboxApi/Errors/IsFileError_html.html new file mode 100644 index 00000000..ce4d39ea --- /dev/null +++ b/doc/docs/DropboxApi/Errors/IsFileError_html.html @@ -0,0 +1,822 @@ + + + + + + +IsFileError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::IsFileError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::IsFileError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">IsFileError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::IsFileError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::IsFileError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/IsFolderError_html.html b/doc/docs/DropboxApi/Errors/IsFolderError_html.html new file mode 100644 index 00000000..57047260 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/IsFolderError_html.html @@ -0,0 +1,822 @@ + + + + + + +IsFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::IsFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::IsFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">IsFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::IsFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::IsFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/IsOsxPackageError_html.html b/doc/docs/DropboxApi/Errors/IsOsxPackageError_html.html new file mode 100644 index 00000000..e1931e6e --- /dev/null +++ b/doc/docs/DropboxApi/Errors/IsOsxPackageError_html.html @@ -0,0 +1,822 @@ + + + + + + +IsOsxPackageError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::IsOsxPackageError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::IsOsxPackageError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">IsOsxPackageError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::IsOsxPackageError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::IsOsxPackageError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/IsPublicFolderError_html.html b/doc/docs/DropboxApi/Errors/IsPublicFolderError_html.html new file mode 100644 index 00000000..55a3bb7d --- /dev/null +++ b/doc/docs/DropboxApi/Errors/IsPublicFolderError_html.html @@ -0,0 +1,822 @@ + + + + + + +IsPublicFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::IsPublicFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::IsPublicFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (I)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">IsPublicFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::IsPublicFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::IsPublicFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/ListFolderContinueError_html.html b/doc/docs/DropboxApi/Errors/ListFolderContinueError_html.html new file mode 100644 index 00000000..9b651153 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/ListFolderContinueError_html.html @@ -0,0 +1,842 @@ + + + + + + +ListFolderContinueError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::ListFolderContinueError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::ListFolderContinueError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">ListFolderContinueError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::ListFolderContinueError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::ListFolderContinueError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/list_folder_continue_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span></span><span class='comma'>,</span>
+<span class='label'>reset:</span> <span class='const'><span class='object_link'><a href="InvalidCursorError.html" title="DropboxApi::Errors::InvalidCursorError (class)">InvalidCursorError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/ListFolderError_html.html b/doc/docs/DropboxApi/Errors/ListFolderError_html.html new file mode 100644 index 00000000..ffcbb646 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/ListFolderError_html.html @@ -0,0 +1,841 @@ + + + + + + +ListFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::ListFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::ListFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">ListFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::ListFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::ListFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/list_folder_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/ListFolderLongpollError_html.html b/doc/docs/DropboxApi/Errors/ListFolderLongpollError_html.html new file mode 100644 index 00000000..6507011f --- /dev/null +++ b/doc/docs/DropboxApi/Errors/ListFolderLongpollError_html.html @@ -0,0 +1,841 @@ + + + + + + +ListFolderLongpollError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::ListFolderLongpollError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::ListFolderLongpollError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">ListFolderLongpollError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::ListFolderLongpollError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::ListFolderLongpollError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/list_folder_longpoll_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>reset:</span> <span class='const'><span class='object_link'><a href="InvalidCursorError.html" title="DropboxApi::Errors::InvalidCursorError (class)">InvalidCursorError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/ListRevisionsError_html.html b/doc/docs/DropboxApi/Errors/ListRevisionsError_html.html new file mode 100644 index 00000000..cadaa662 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/ListRevisionsError_html.html @@ -0,0 +1,841 @@ + + + + + + +ListRevisionsError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::ListRevisionsError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::ListRevisionsError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">ListRevisionsError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::ListRevisionsError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::ListRevisionsError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/list_revisions_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/ListSharedLinksError_html.html b/doc/docs/DropboxApi/Errors/ListSharedLinksError_html.html new file mode 100644 index 00000000..17e3fdaa --- /dev/null +++ b/doc/docs/DropboxApi/Errors/ListSharedLinksError_html.html @@ -0,0 +1,842 @@ + + + + + + +ListSharedLinksError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::ListSharedLinksError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::ListSharedLinksError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">ListSharedLinksError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::ListSharedLinksError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::ListSharedLinksError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/list_shared_links_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span><span class='comma'>,</span>
+<span class='label'>reset:</span> <span class='const'><span class='object_link'><a href="InvalidCursorError.html" title="DropboxApi::Errors::InvalidCursorError (class)">InvalidCursorError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/LookupError_html.html b/doc/docs/DropboxApi/Errors/LookupError_html.html new file mode 100644 index 00000000..3296f33f --- /dev/null +++ b/doc/docs/DropboxApi/Errors/LookupError_html.html @@ -0,0 +1,845 @@ + + + + + + +LookupError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::LookupError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::LookupError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">LookupError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::LookupError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::LookupError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/lookup_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>malformed_path:</span> <span class='const'><span class='object_link'><a href="MalformedPathError.html" title="DropboxApi::Errors::MalformedPathError (class)">MalformedPathError</a></span></span><span class='comma'>,</span>
+<span class='label'>not_found:</span> <span class='const'><span class='object_link'><a href="NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span></span><span class='comma'>,</span>
+<span class='label'>not_file:</span> <span class='const'><span class='object_link'><a href="NotFileError.html" title="DropboxApi::Errors::NotFileError (class)">NotFileError</a></span></span><span class='comma'>,</span>
+<span class='label'>not_folder:</span> <span class='const'><span class='object_link'><a href="NotFolderError.html" title="DropboxApi::Errors::NotFolderError (class)">NotFolderError</a></span></span><span class='comma'>,</span>
+<span class='label'>restricted_content:</span> <span class='const'><span class='object_link'><a href="RestrictedContentError.html" title="DropboxApi::Errors::RestrictedContentError (class)">RestrictedContentError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/MalformedPathError_html.html b/doc/docs/DropboxApi/Errors/MalformedPathError_html.html new file mode 100644 index 00000000..fc5c3264 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/MalformedPathError_html.html @@ -0,0 +1,822 @@ + + + + + + +MalformedPathError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::MalformedPathError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::MalformedPathError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">MalformedPathError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::MalformedPathError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::MalformedPathError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/NoAccountError_html.html b/doc/docs/DropboxApi/Errors/NoAccountError_html.html new file mode 100644 index 00000000..108451eb --- /dev/null +++ b/doc/docs/DropboxApi/Errors/NoAccountError_html.html @@ -0,0 +1,822 @@ + + + + + + +NoAccountError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::NoAccountError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::NoAccountError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (N)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">NoAccountError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::NoAccountError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::NoAccountError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/NoPermissionError_html.html b/doc/docs/DropboxApi/Errors/NoPermissionError_html.html new file mode 100644 index 00000000..6d4c87cf --- /dev/null +++ b/doc/docs/DropboxApi/Errors/NoPermissionError_html.html @@ -0,0 +1,822 @@ + + + + + + +NoPermissionError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::NoPermissionError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::NoPermissionError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (N)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">NoPermissionError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::NoPermissionError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::NoPermissionError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/NoWritePermissionError_html.html b/doc/docs/DropboxApi/Errors/NoWritePermissionError_html.html new file mode 100644 index 00000000..570b136d --- /dev/null +++ b/doc/docs/DropboxApi/Errors/NoWritePermissionError_html.html @@ -0,0 +1,822 @@ + + + + + + +NoWritePermissionError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::NoWritePermissionError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::NoWritePermissionError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (N)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">NoWritePermissionError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::NoWritePermissionError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::NoWritePermissionError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/NotAMemberError_html.html b/doc/docs/DropboxApi/Errors/NotAMemberError_html.html new file mode 100644 index 00000000..9127a00a --- /dev/null +++ b/doc/docs/DropboxApi/Errors/NotAMemberError_html.html @@ -0,0 +1,822 @@ + + + + + + +NotAMemberError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::NotAMemberError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::NotAMemberError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (N)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">NotAMemberError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::NotAMemberError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::NotAMemberError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/NotFileError_html.html b/doc/docs/DropboxApi/Errors/NotFileError_html.html new file mode 100644 index 00000000..3c83ec07 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/NotFileError_html.html @@ -0,0 +1,822 @@ + + + + + + +NotFileError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::NotFileError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::NotFileError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (N)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">NotFileError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::NotFileError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::NotFileError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/NotFolderError_html.html b/doc/docs/DropboxApi/Errors/NotFolderError_html.html new file mode 100644 index 00000000..2e1b676e --- /dev/null +++ b/doc/docs/DropboxApi/Errors/NotFolderError_html.html @@ -0,0 +1,822 @@ + + + + + + +NotFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::NotFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::NotFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (N)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">NotFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::NotFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::NotFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/NotFoundError_html.html b/doc/docs/DropboxApi/Errors/NotFoundError_html.html new file mode 100644 index 00000000..99287cf3 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/NotFoundError_html.html @@ -0,0 +1,822 @@ + + + + + + +NotFoundError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::NotFoundError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::NotFoundError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (N)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">NotFoundError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::NotFoundError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::NotFoundError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/PollError_html.html b/doc/docs/DropboxApi/Errors/PollError_html.html new file mode 100644 index 00000000..129ad195 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/PollError_html.html @@ -0,0 +1,842 @@ + + + + + + +PollError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::PollError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::PollError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (P)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">PollError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::PollError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::PollError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/poll_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>invalid_async_job_id:</span> <span class='const'><span class='object_link'><a href="InvalidIdError.html" title="DropboxApi::Errors::InvalidIdError (class)">InvalidIdError</a></span></span><span class='comma'>,</span>
+<span class='label'>internal_error:</span> <span class='const'><span class='object_link'><a href="InternalError.html" title="DropboxApi::Errors::InternalError (class)">InternalError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/PreviewError_html.html b/doc/docs/DropboxApi/Errors/PreviewError_html.html new file mode 100644 index 00000000..8533d5b0 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/PreviewError_html.html @@ -0,0 +1,844 @@ + + + + + + +PreviewError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::PreviewError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::PreviewError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (P)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">PreviewError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::PreviewError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::PreviewError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/preview_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span><span class='comma'>,</span>
+<span class='label'>in_progress:</span> <span class='const'><span class='object_link'><a href="InProgressError.html" title="DropboxApi::Errors::InProgressError (class)">InProgressError</a></span></span><span class='comma'>,</span>
+<span class='label'>unsupported_extension:</span> <span class='const'><span class='object_link'><a href="UnsupportedExtensionError.html" title="DropboxApi::Errors::UnsupportedExtensionError (class)">UnsupportedExtensionError</a></span></span><span class='comma'>,</span>
+<span class='label'>unsupported_content:</span> <span class='const'><span class='object_link'><a href="UnsupportedContentError.html" title="DropboxApi::Errors::UnsupportedContentError (class)">UnsupportedContentError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/RateLimitError_html.html b/doc/docs/DropboxApi/Errors/RateLimitError_html.html new file mode 100644 index 00000000..bc5b8935 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/RateLimitError_html.html @@ -0,0 +1,822 @@ + + + + + + +RateLimitError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::RateLimitError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::RateLimitError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">RateLimitError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::RateLimitError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::RateLimitError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/RelocationBatchEntryError_html.html b/doc/docs/DropboxApi/Errors/RelocationBatchEntryError_html.html new file mode 100644 index 00000000..1e755f25 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/RelocationBatchEntryError_html.html @@ -0,0 +1,843 @@ + + + + + + +RelocationBatchEntryError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::RelocationBatchEntryError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::RelocationBatchEntryError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">RelocationBatchEntryError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::RelocationBatchEntryError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::RelocationBatchEntryError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/relocation_batch_entry_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>relocation_error:</span> <span class='const'><span class='object_link'><a href="RelocationError.html" title="DropboxApi::Errors::RelocationError (class)">RelocationError</a></span></span><span class='comma'>,</span>
+<span class='label'>internal_error:</span> <span class='const'><span class='object_link'><a href="InternalError.html" title="DropboxApi::Errors::InternalError (class)">InternalError</a></span></span><span class='comma'>,</span>
+<span class='label'>too_many_write_operations:</span> <span class='const'><span class='object_link'><a href="TooManyWriteOperationsError.html" title="DropboxApi::Errors::TooManyWriteOperationsError (class)">TooManyWriteOperationsError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/RelocationError_html.html b/doc/docs/DropboxApi/Errors/RelocationError_html.html new file mode 100644 index 00000000..60248a5f --- /dev/null +++ b/doc/docs/DropboxApi/Errors/RelocationError_html.html @@ -0,0 +1,847 @@ + + + + + + +RelocationError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::RelocationError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::RelocationError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">RelocationError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::RelocationError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::RelocationError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/relocation_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>from_lookup:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span><span class='comma'>,</span>
+<span class='label'>from_write:</span> <span class='const'><span class='object_link'><a href="WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span></span><span class='comma'>,</span>
+<span class='label'>to:</span> <span class='const'><span class='object_link'><a href="WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span></span><span class='comma'>,</span>
+<span class='label'>cant_copy_shared_folder:</span> <span class='const'><span class='object_link'><a href="CantCopySharedFolderError.html" title="DropboxApi::Errors::CantCopySharedFolderError (class)">CantCopySharedFolderError</a></span></span><span class='comma'>,</span>
+<span class='label'>cant_nest_shared_folder:</span> <span class='const'><span class='object_link'><a href="CantNestSharedFolderError.html" title="DropboxApi::Errors::CantNestSharedFolderError (class)">CantNestSharedFolderError</a></span></span><span class='comma'>,</span>
+<span class='label'>cant_move_folder_into_itself:</span> <span class='const'><span class='object_link'><a href="CantMoveFolderIntoItselfError.html" title="DropboxApi::Errors::CantMoveFolderIntoItselfError (class)">CantMoveFolderIntoItselfError</a></span></span><span class='comma'>,</span>
+<span class='label'>too_many_files:</span> <span class='const'><span class='object_link'><a href="TooManyFilesError.html" title="DropboxApi::Errors::TooManyFilesError (class)">TooManyFilesError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/RestoreError_html.html b/doc/docs/DropboxApi/Errors/RestoreError_html.html new file mode 100644 index 00000000..f711a9ef --- /dev/null +++ b/doc/docs/DropboxApi/Errors/RestoreError_html.html @@ -0,0 +1,843 @@ + + + + + + +RestoreError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::RestoreError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::RestoreError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">RestoreError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::RestoreError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::RestoreError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/restore_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path_lookup:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span><span class='comma'>,</span>
+<span class='label'>path_write:</span> <span class='const'><span class='object_link'><a href="WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span></span><span class='comma'>,</span>
+<span class='label'>invalid_revision:</span> <span class='const'><span class='object_link'><a href="InvalidRevisionError.html" title="DropboxApi::Errors::InvalidRevisionError (class)">InvalidRevisionError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/RestrictedContentError_html.html b/doc/docs/DropboxApi/Errors/RestrictedContentError_html.html new file mode 100644 index 00000000..3824df01 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/RestrictedContentError_html.html @@ -0,0 +1,822 @@ + + + + + + +RestrictedContentError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::RestrictedContentError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::RestrictedContentError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">RestrictedContentError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::RestrictedContentError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::RestrictedContentError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/RevokeSharedLinkError_html.html b/doc/docs/DropboxApi/Errors/RevokeSharedLinkError_html.html new file mode 100644 index 00000000..4fc425c7 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/RevokeSharedLinkError_html.html @@ -0,0 +1,844 @@ + + + + + + +RevokeSharedLinkError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::RevokeSharedLinkError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::RevokeSharedLinkError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">RevokeSharedLinkError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::RevokeSharedLinkError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::RevokeSharedLinkError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/revoke_shared_link_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>shared_link_not_found:</span> <span class='const'><span class='object_link'><a href="SharedLinkNotFoundError.html" title="DropboxApi::Errors::SharedLinkNotFoundError (class)">SharedLinkNotFoundError</a></span></span><span class='comma'>,</span>
+<span class='label'>shared_link_access_denied:</span> <span class='const'><span class='object_link'><a href="SharedLinkAccessDeniedError.html" title="DropboxApi::Errors::SharedLinkAccessDeniedError (class)">SharedLinkAccessDeniedError</a></span></span><span class='comma'>,</span>
+<span class='label'>unsupported_link_type:</span> <span class='const'><span class='object_link'><a href="UnsupportedLinkTypeError.html" title="DropboxApi::Errors::UnsupportedLinkTypeError (class)">UnsupportedLinkTypeError</a></span></span><span class='comma'>,</span>
+<span class='label'>shared_link_malformed:</span> <span class='const'><span class='object_link'><a href="SharedLinkMalformedError.html" title="DropboxApi::Errors::SharedLinkMalformedError (class)">SharedLinkMalformedError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SaveCopyReferenceError_html.html b/doc/docs/DropboxApi/Errors/SaveCopyReferenceError_html.html new file mode 100644 index 00000000..43ea1982 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SaveCopyReferenceError_html.html @@ -0,0 +1,845 @@ + + + + + + +SaveCopyReferenceError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SaveCopyReferenceError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SaveCopyReferenceError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SaveCopyReferenceError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SaveCopyReferenceError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SaveCopyReferenceError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/save_copy_reference_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span></span><span class='comma'>,</span>
+<span class='label'>invalid_copy_reference:</span> <span class='const'><span class='object_link'><a href="InvalidCopyReferenceError.html" title="DropboxApi::Errors::InvalidCopyReferenceError (class)">InvalidCopyReferenceError</a></span></span><span class='comma'>,</span>
+<span class='label'>no_permission:</span> <span class='const'><span class='object_link'><a href="NoPermissionError.html" title="DropboxApi::Errors::NoPermissionError (class)">NoPermissionError</a></span></span><span class='comma'>,</span>
+<span class='label'>not_found:</span> <span class='const'><span class='object_link'><a href="NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span></span><span class='comma'>,</span>
+<span class='label'>too_many_files:</span> <span class='const'><span class='object_link'><a href="TooManyFilesError.html" title="DropboxApi::Errors::TooManyFilesError (class)">TooManyFilesError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SaveUrlError_html.html b/doc/docs/DropboxApi/Errors/SaveUrlError_html.html new file mode 100644 index 00000000..5fb3e0a6 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SaveUrlError_html.html @@ -0,0 +1,844 @@ + + + + + + +SaveUrlError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SaveUrlError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SaveUrlError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SaveUrlError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SaveUrlError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SaveUrlError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/save_url_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span></span><span class='comma'>,</span>
+<span class='label'>download_failed:</span> <span class='const'><span class='object_link'><a href="DownloadFailedError.html" title="DropboxApi::Errors::DownloadFailedError (class)">DownloadFailedError</a></span></span><span class='comma'>,</span>
+<span class='label'>invalid_url:</span> <span class='const'><span class='object_link'><a href="InvalidUrlError.html" title="DropboxApi::Errors::InvalidUrlError (class)">InvalidUrlError</a></span></span><span class='comma'>,</span>
+<span class='label'>not_found:</span> <span class='const'><span class='object_link'><a href="NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SearchError_html.html b/doc/docs/DropboxApi/Errors/SearchError_html.html new file mode 100644 index 00000000..7142ac38 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SearchError_html.html @@ -0,0 +1,841 @@ + + + + + + +SearchError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SearchError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SearchError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SearchError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SearchError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SearchError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/search_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SettingsError_html.html b/doc/docs/DropboxApi/Errors/SettingsError_html.html new file mode 100644 index 00000000..0355940c --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SettingsError_html.html @@ -0,0 +1,842 @@ + + + + + + +SettingsError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SettingsError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SettingsError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SettingsError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SettingsError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SettingsError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/settings_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>invalid_settings:</span> <span class='const'><span class='object_link'><a href="InvalidSettingsError.html" title="DropboxApi::Errors::InvalidSettingsError (class)">InvalidSettingsError</a></span></span><span class='comma'>,</span>
+<span class='label'>not_authorized:</span> <span class='const'><span class='object_link'><a href="NoPermissionError.html" title="DropboxApi::Errors::NoPermissionError (class)">NoPermissionError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/ShareFolderError_html.html b/doc/docs/DropboxApi/Errors/ShareFolderError_html.html new file mode 100644 index 00000000..cba08393 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/ShareFolderError_html.html @@ -0,0 +1,845 @@ + + + + + + +ShareFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::ShareFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::ShareFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">ShareFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::ShareFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::ShareFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/share_folder_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>email_unverified:</span> <span class='const'><span class='object_link'><a href="EmailUnverifiedError.html" title="DropboxApi::Errors::EmailUnverifiedError (class)">EmailUnverifiedError</a></span></span><span class='comma'>,</span>
+<span class='label'>bad_path:</span> <span class='const'><span class='object_link'><a href="SharePathError.html" title="DropboxApi::Errors::SharePathError (class)">SharePathError</a></span></span><span class='comma'>,</span>
+<span class='label'>team_policy_disallows_member_policy:</span> <span class='const'><span class='object_link'><a href="TeamPolicyDisallowsMemberPolicyError.html" title="DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError (class)">TeamPolicyDisallowsMemberPolicyError</a></span></span><span class='comma'>,</span>
+<span class='label'>disallowed_shared_link_policy:</span> <span class='const'><span class='object_link'><a href="DisallowedSharedLinkPolicyError.html" title="DropboxApi::Errors::DisallowedSharedLinkPolicyError (class)">DisallowedSharedLinkPolicyError</a></span></span><span class='comma'>,</span>
+<span class='label'>no_permission:</span> <span class='const'><span class='object_link'><a href="NoPermissionError.html" title="DropboxApi::Errors::NoPermissionError (class)">NoPermissionError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SharePathError_html.html b/doc/docs/DropboxApi/Errors/SharePathError_html.html new file mode 100644 index 00000000..61422203 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SharePathError_html.html @@ -0,0 +1,851 @@ + + + + + + +SharePathError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SharePathError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SharePathError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SharePathError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SharePathError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SharePathError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/share_path_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>is_file:</span> <span class='const'><span class='object_link'><a href="IsFileError.html" title="DropboxApi::Errors::IsFileError (class)">IsFileError</a></span></span><span class='comma'>,</span>
+<span class='label'>inside_shared_folder:</span> <span class='const'><span class='object_link'><a href="InsideSharedFolderError.html" title="DropboxApi::Errors::InsideSharedFolderError (class)">InsideSharedFolderError</a></span></span><span class='comma'>,</span>
+<span class='label'>contains_shared_folder:</span> <span class='const'><span class='object_link'><a href="ContainsSharedFolderError.html" title="DropboxApi::Errors::ContainsSharedFolderError (class)">ContainsSharedFolderError</a></span></span><span class='comma'>,</span>
+<span class='label'>is_app_folder:</span> <span class='const'><span class='object_link'><a href="IsAppFolderError.html" title="DropboxApi::Errors::IsAppFolderError (class)">IsAppFolderError</a></span></span><span class='comma'>,</span>
+<span class='label'>inside_app_folder:</span> <span class='const'><span class='object_link'><a href="InsideAppFolderError.html" title="DropboxApi::Errors::InsideAppFolderError (class)">InsideAppFolderError</a></span></span><span class='comma'>,</span>
+<span class='label'>is_public_folder:</span> <span class='const'><span class='object_link'><a href="IsPublicFolderError.html" title="DropboxApi::Errors::IsPublicFolderError (class)">IsPublicFolderError</a></span></span><span class='comma'>,</span>
+<span class='label'>inside_public_folder:</span> <span class='const'><span class='object_link'><a href="InsidePublicFolderError.html" title="DropboxApi::Errors::InsidePublicFolderError (class)">InsidePublicFolderError</a></span></span><span class='comma'>,</span>
+<span class='label'>already_shared:</span> <span class='const'><span class='object_link'><a href="AlreadySharedError.html" title="DropboxApi::Errors::AlreadySharedError (class)">AlreadySharedError</a></span></span><span class='comma'>,</span>
+<span class='label'>invalid_path:</span> <span class='const'><span class='object_link'><a href="InvalidPathError.html" title="DropboxApi::Errors::InvalidPathError (class)">InvalidPathError</a></span></span><span class='comma'>,</span>
+<span class='label'>is_osx_package:</span> <span class='const'><span class='object_link'><a href="IsOsxPackageError.html" title="DropboxApi::Errors::IsOsxPackageError (class)">IsOsxPackageError</a></span></span><span class='comma'>,</span>
+<span class='label'>inside_osx_package:</span> <span class='const'><span class='object_link'><a href="InsideOsxPackageError.html" title="DropboxApi::Errors::InsideOsxPackageError (class)">InsideOsxPackageError</a></span></span><span class='comma'>,</span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SharedFolderAccessError_html.html b/doc/docs/DropboxApi/Errors/SharedFolderAccessError_html.html new file mode 100644 index 00000000..33adfdcf --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SharedFolderAccessError_html.html @@ -0,0 +1,844 @@ + + + + + + +SharedFolderAccessError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SharedFolderAccessError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SharedFolderAccessError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SharedFolderAccessError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SharedFolderAccessError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SharedFolderAccessError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/shared_folder_access_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>invalid_id:</span> <span class='const'><span class='object_link'><a href="InvalidIdError.html" title="DropboxApi::Errors::InvalidIdError (class)">InvalidIdError</a></span></span><span class='comma'>,</span>
+<span class='label'>not_a_member:</span> <span class='const'><span class='object_link'><a href="NotAMemberError.html" title="DropboxApi::Errors::NotAMemberError (class)">NotAMemberError</a></span></span><span class='comma'>,</span>
+<span class='label'>email_unverified:</span> <span class='const'><span class='object_link'><a href="EmailUnverifiedError.html" title="DropboxApi::Errors::EmailUnverifiedError (class)">EmailUnverifiedError</a></span></span><span class='comma'>,</span>
+<span class='label'>unmounted:</span> <span class='const'><span class='object_link'><a href="UnmountedError.html" title="DropboxApi::Errors::UnmountedError (class)">UnmountedError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SharedLinkAccessDeniedError_html.html b/doc/docs/DropboxApi/Errors/SharedLinkAccessDeniedError_html.html new file mode 100644 index 00000000..d04ad07e --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SharedLinkAccessDeniedError_html.html @@ -0,0 +1,822 @@ + + + + + + +SharedLinkAccessDeniedError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SharedLinkAccessDeniedError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SharedLinkAccessDeniedError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SharedLinkAccessDeniedError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SharedLinkAccessDeniedError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SharedLinkAccessDeniedError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError_html.html b/doc/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError_html.html new file mode 100644 index 00000000..075732ff --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError_html.html @@ -0,0 +1,822 @@ + + + + + + +SharedLinkAlreadyExistsError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SharedLinkAlreadyExistsError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SharedLinkAlreadyExistsError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SharedLinkAlreadyExistsError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SharedLinkAlreadyExistsError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SharedLinkAlreadyExistsError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SharedLinkError_html.html b/doc/docs/DropboxApi/Errors/SharedLinkError_html.html new file mode 100644 index 00000000..24e21a59 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SharedLinkError_html.html @@ -0,0 +1,843 @@ + + + + + + +SharedLinkError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SharedLinkError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SharedLinkError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SharedLinkError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SharedLinkError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SharedLinkError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/shared_link_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>shared_link_not_found:</span> <span class='const'><span class='object_link'><a href="SharedLinkNotFoundError.html" title="DropboxApi::Errors::SharedLinkNotFoundError (class)">SharedLinkNotFoundError</a></span></span><span class='comma'>,</span>
+<span class='label'>shared_link_access_denied:</span> <span class='const'><span class='object_link'><a href="SharedLinkAccessDeniedError.html" title="DropboxApi::Errors::SharedLinkAccessDeniedError (class)">SharedLinkAccessDeniedError</a></span></span><span class='comma'>,</span>
+<span class='label'>unsupported_link_type:</span> <span class='const'><span class='object_link'><a href="UnsupportedLinkTypeError.html" title="DropboxApi::Errors::UnsupportedLinkTypeError (class)">UnsupportedLinkTypeError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SharedLinkMalformedError_html.html b/doc/docs/DropboxApi/Errors/SharedLinkMalformedError_html.html new file mode 100644 index 00000000..6defb7a7 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SharedLinkMalformedError_html.html @@ -0,0 +1,822 @@ + + + + + + +SharedLinkMalformedError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SharedLinkMalformedError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SharedLinkMalformedError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SharedLinkMalformedError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SharedLinkMalformedError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SharedLinkMalformedError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SharedLinkNotFoundError_html.html b/doc/docs/DropboxApi/Errors/SharedLinkNotFoundError_html.html new file mode 100644 index 00000000..d2116559 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SharedLinkNotFoundError_html.html @@ -0,0 +1,822 @@ + + + + + + +SharedLinkNotFoundError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SharedLinkNotFoundError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SharedLinkNotFoundError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SharedLinkNotFoundError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SharedLinkNotFoundError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SharedLinkNotFoundError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SharingFileAccessError_html.html b/doc/docs/DropboxApi/Errors/SharingFileAccessError_html.html new file mode 100644 index 00000000..cc1204dd --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SharingFileAccessError_html.html @@ -0,0 +1,845 @@ + + + + + + +SharingFileAccessError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SharingFileAccessError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SharingFileAccessError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SharingFileAccessError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SharingFileAccessError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SharingFileAccessError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/sharing_file_access_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>no_permission:</span> <span class='const'><span class='object_link'><a href="NoPermissionError.html" title="DropboxApi::Errors::NoPermissionError (class)">NoPermissionError</a></span></span><span class='comma'>,</span>
+<span class='label'>invalid_file:</span> <span class='const'><span class='object_link'><a href="InvalidFileError.html" title="DropboxApi::Errors::InvalidFileError (class)">InvalidFileError</a></span></span><span class='comma'>,</span>
+<span class='label'>is_folder:</span> <span class='const'><span class='object_link'><a href="IsFolderError.html" title="DropboxApi::Errors::IsFolderError (class)">IsFolderError</a></span></span><span class='comma'>,</span>
+<span class='label'>inside_public_folder:</span> <span class='const'><span class='object_link'><a href="InsidePublicFolderError.html" title="DropboxApi::Errors::InsidePublicFolderError (class)">InsidePublicFolderError</a></span></span><span class='comma'>,</span>
+<span class='label'>inside_osx_package:</span> <span class='const'><span class='object_link'><a href="InsideOsxPackageError.html" title="DropboxApi::Errors::InsideOsxPackageError (class)">InsideOsxPackageError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/SharingUserError_html.html b/doc/docs/DropboxApi/Errors/SharingUserError_html.html new file mode 100644 index 00000000..d56bd53e --- /dev/null +++ b/doc/docs/DropboxApi/Errors/SharingUserError_html.html @@ -0,0 +1,841 @@ + + + + + + +SharingUserError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::SharingUserError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::SharingUserError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">SharingUserError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::SharingUserError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::SharingUserError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/sharing_user_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>email_unverified:</span> <span class='const'><span class='object_link'><a href="EmailUnverifiedError.html" title="DropboxApi::Errors::EmailUnverifiedError (class)">EmailUnverifiedError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/TeamFolderError_html.html b/doc/docs/DropboxApi/Errors/TeamFolderError_html.html new file mode 100644 index 00000000..b426d421 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/TeamFolderError_html.html @@ -0,0 +1,822 @@ + + + + + + +TeamFolderError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::TeamFolderError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::TeamFolderError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">TeamFolderError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::TeamFolderError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::TeamFolderError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError_html.html b/doc/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError_html.html new file mode 100644 index 00000000..020c950b --- /dev/null +++ b/doc/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError_html.html @@ -0,0 +1,822 @@ + + + + + + +TeamPolicyDisallowsMemberPolicyError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">TeamPolicyDisallowsMemberPolicyError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/ThumbnailBatchError_html.html b/doc/docs/DropboxApi/Errors/ThumbnailBatchError_html.html new file mode 100644 index 00000000..ca177bbd --- /dev/null +++ b/doc/docs/DropboxApi/Errors/ThumbnailBatchError_html.html @@ -0,0 +1,841 @@ + + + + + + +ThumbnailBatchError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::ThumbnailBatchError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::ThumbnailBatchError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">ThumbnailBatchError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::ThumbnailBatchError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::ThumbnailBatchError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/thumbnail_batch_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>too_many_files:</span> <span class='const'><span class='object_link'><a href="TooManyFilesError.html" title="DropboxApi::Errors::TooManyFilesError (class)">TooManyFilesError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/ThumbnailError_html.html b/doc/docs/DropboxApi/Errors/ThumbnailError_html.html new file mode 100644 index 00000000..da2114e3 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/ThumbnailError_html.html @@ -0,0 +1,844 @@ + + + + + + +ThumbnailError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::ThumbnailError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::ThumbnailError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">ThumbnailError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::ThumbnailError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::ThumbnailError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/thumbnail_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span></span><span class='comma'>,</span>
+<span class='label'>unsupported_extension:</span> <span class='const'><span class='object_link'><a href="UnsupportedExtensionError.html" title="DropboxApi::Errors::UnsupportedExtensionError (class)">UnsupportedExtensionError</a></span></span><span class='comma'>,</span>
+<span class='label'>unsupported_image:</span> <span class='const'><span class='object_link'><a href="UnsupportedImageError.html" title="DropboxApi::Errors::UnsupportedImageError (class)">UnsupportedImageError</a></span></span><span class='comma'>,</span>
+<span class='label'>conversion_error:</span> <span class='const'><span class='object_link'><a href="ConversionError.html" title="DropboxApi::Errors::ConversionError (class)">ConversionError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/TooManyFilesError_html.html b/doc/docs/DropboxApi/Errors/TooManyFilesError_html.html new file mode 100644 index 00000000..198c8414 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/TooManyFilesError_html.html @@ -0,0 +1,822 @@ + + + + + + +TooManyFilesError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::TooManyFilesError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::TooManyFilesError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">TooManyFilesError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::TooManyFilesError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::TooManyFilesError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/TooManyMembersError_html.html b/doc/docs/DropboxApi/Errors/TooManyMembersError_html.html new file mode 100644 index 00000000..2674a391 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/TooManyMembersError_html.html @@ -0,0 +1,822 @@ + + + + + + +TooManyMembersError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::TooManyMembersError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::TooManyMembersError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">TooManyMembersError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::TooManyMembersError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::TooManyMembersError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/TooManyPendingInvitesError_html.html b/doc/docs/DropboxApi/Errors/TooManyPendingInvitesError_html.html new file mode 100644 index 00000000..a01020f8 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/TooManyPendingInvitesError_html.html @@ -0,0 +1,822 @@ + + + + + + +TooManyPendingInvitesError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::TooManyPendingInvitesError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::TooManyPendingInvitesError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">TooManyPendingInvitesError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::TooManyPendingInvitesError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::TooManyPendingInvitesError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/TooManyRequestsError_html.html b/doc/docs/DropboxApi/Errors/TooManyRequestsError_html.html new file mode 100644 index 00000000..a9b5495c --- /dev/null +++ b/doc/docs/DropboxApi/Errors/TooManyRequestsError_html.html @@ -0,0 +1,974 @@ + + + + + + +TooManyRequestsError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::TooManyRequestsError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::TooManyRequestsError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">TooManyRequestsError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::TooManyRequestsError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::TooManyRequestsError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/too_many_requests_error.rb<span class="defines">,<br />
+lib/dropbox_api/errors/too_many_requests_error.rb</span>
+ +

</dd>

+ +
</dl>
+ +

</div>

+ +

<div id=“subclasses”>

+ +
<h2>Direct Known Subclasses</h2>
+<p class="children"><span class='object_link'><a href="TooManyWriteOperationsError.html" title="DropboxApi::Errors::TooManyWriteOperationsError (class)">TooManyWriteOperationsError</a></span></p>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>too_many_requests:</span> <span class='const'>TooManyRequestsError</span><span class='comma'>,</span>
+<span class='label'>too_many_write_operations:</span> <span class='const'><span class='object_link'><a href="TooManyWriteOperationsError.html" title="DropboxApi::Errors::TooManyWriteOperationsError (class)">TooManyWriteOperationsError</a></span></span>
+ +

<span class='rbrace'>}</span></pre></dd>

+ +
  </dl>
+
+<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+<ul class="summary">
+
+    <li class="public ">
+<span class="summary_signature">
+
+    <a href="#retry_after-instance_method" title="#retry_after (instance method)">#<strong>retry_after</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the value of attribute retry_after.</p>
+ +

</div></span>

+ +

</li>

+ +
</ul>
+
+  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build-class_method" title="build (class method)">.<strong>build</strong>(message, metadata)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +
<div id="instance_attr_details" class="attr_details">
+  <h2>Instance Attribute Details</h2>
+
+    <span id="retry_after=-instance_method"></span>
+    <div class="method_details first">
+<h3 class="signature first" id="retry_after-instance_method">
+
+  #<strong>retry_after</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the value of attribute retry_after.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/errors/too_many_requests_error.rb', line 7</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_retry_after'>retry_after</span>

+ +
<span class='ivar'>@retry_after</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+
+<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build-class_method">
+
+  .<strong>build</strong>(message, metadata)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

9 10 11 12 13</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/errors/too_many_requests_error.rb', line 9</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_build'>build</span><span +class='lparen'>(</span><span class='id identifier +rubyid_message'>message</span><span +class='comma'>,</span> <span class='id identifier +rubyid_metadata'>metadata</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_subtype'>subtype</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='op'>=</span> <span class='id identifier rubyid_find_subtype'>find_subtype</span> <span class='id identifier rubyid_metadata'>metadata</span>
+
+<span class='id identifier rubyid_subtype'>subtype</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/TooManySharedFolderTargetsError_html.html b/doc/docs/DropboxApi/Errors/TooManySharedFolderTargetsError_html.html new file mode 100644 index 00000000..c4049e8c --- /dev/null +++ b/doc/docs/DropboxApi/Errors/TooManySharedFolderTargetsError_html.html @@ -0,0 +1,822 @@ + + + + + + +TooManySharedFolderTargetsError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::TooManySharedFolderTargetsError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::TooManySharedFolderTargetsError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">TooManySharedFolderTargetsError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::TooManySharedFolderTargetsError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::TooManySharedFolderTargetsError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/TooManyWriteOperationsError_html.html b/doc/docs/DropboxApi/Errors/TooManyWriteOperationsError_html.html new file mode 100644 index 00000000..a5d6e982 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/TooManyWriteOperationsError_html.html @@ -0,0 +1,838 @@ + + + + + + +TooManyWriteOperationsError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::TooManyWriteOperationsError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::TooManyWriteOperationsError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">TooManyWriteOperationsError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::TooManyWriteOperationsError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="TooManyRequestsError.html" title="DropboxApi::Errors::TooManyRequestsError (class)">TooManyRequestsError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="TooManyRequestsError.html" title="DropboxApi::Errors::TooManyRequestsError (class)">TooManyRequestsError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::TooManyWriteOperationsError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/too_many_requests_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Constant Summary</h2>
+
+<h3 class="inherited">Constants inherited
+   from <span class='object_link'><a href="TooManyRequestsError.html" title="DropboxApi::Errors::TooManyRequestsError (class)">TooManyRequestsError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="TooManyRequestsError.html#ErrorSubtypes-constant" title="DropboxApi::Errors::TooManyRequestsError::ErrorSubtypes (constant)">DropboxApi::Errors::TooManyRequestsError::ErrorSubtypes</a></span></p>
+
+<h2>Instance Attribute Summary</h2>
+
+<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="TooManyRequestsError.html" title="DropboxApi::Errors::TooManyRequestsError (class)">TooManyRequestsError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="TooManyRequestsError.html#retry_after-instance_method" title="DropboxApi::Errors::TooManyRequestsError#retry_after (method)">#retry_after</a></span></p>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="TooManyRequestsError.html" title="DropboxApi::Errors::TooManyRequestsError (class)">TooManyRequestsError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="TooManyRequestsError.html#build-class_method" title="DropboxApi::Errors::TooManyRequestsError.build (method)">build</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/UnmountedError_html.html b/doc/docs/DropboxApi/Errors/UnmountedError_html.html new file mode 100644 index 00000000..da7d2660 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/UnmountedError_html.html @@ -0,0 +1,822 @@ + + + + + + +UnmountedError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::UnmountedError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::UnmountedError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">UnmountedError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::UnmountedError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::UnmountedError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/UnshareFileError_html.html b/doc/docs/DropboxApi/Errors/UnshareFileError_html.html new file mode 100644 index 00000000..6c9c7e88 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/UnshareFileError_html.html @@ -0,0 +1,842 @@ + + + + + + +UnshareFileError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::UnshareFileError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::UnshareFileError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">UnshareFileError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::UnshareFileError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::UnshareFileError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/unshare_file_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>user_error:</span> <span class='const'><span class='object_link'><a href="SharingUserError.html" title="DropboxApi::Errors::SharingUserError (class)">SharingUserError</a></span></span><span class='comma'>,</span>
+<span class='label'>access_error:</span> <span class='const'><span class='object_link'><a href="SharingFileAccessError.html" title="DropboxApi::Errors::SharingFileAccessError (class)">SharingFileAccessError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/UnsupportedContentError_html.html b/doc/docs/DropboxApi/Errors/UnsupportedContentError_html.html new file mode 100644 index 00000000..741bdf42 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/UnsupportedContentError_html.html @@ -0,0 +1,822 @@ + + + + + + +UnsupportedContentError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::UnsupportedContentError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::UnsupportedContentError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">UnsupportedContentError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::UnsupportedContentError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::UnsupportedContentError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/UnsupportedExtensionError_html.html b/doc/docs/DropboxApi/Errors/UnsupportedExtensionError_html.html new file mode 100644 index 00000000..f03bf118 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/UnsupportedExtensionError_html.html @@ -0,0 +1,822 @@ + + + + + + +UnsupportedExtensionError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::UnsupportedExtensionError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::UnsupportedExtensionError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">UnsupportedExtensionError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::UnsupportedExtensionError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::UnsupportedExtensionError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/UnsupportedImageError_html.html b/doc/docs/DropboxApi/Errors/UnsupportedImageError_html.html new file mode 100644 index 00000000..f88f32b0 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/UnsupportedImageError_html.html @@ -0,0 +1,822 @@ + + + + + + +UnsupportedImageError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::UnsupportedImageError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::UnsupportedImageError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">UnsupportedImageError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::UnsupportedImageError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::UnsupportedImageError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/UnsupportedLinkTypeError_html.html b/doc/docs/DropboxApi/Errors/UnsupportedLinkTypeError_html.html new file mode 100644 index 00000000..97f39a7b --- /dev/null +++ b/doc/docs/DropboxApi/Errors/UnsupportedLinkTypeError_html.html @@ -0,0 +1,822 @@ + + + + + + +UnsupportedLinkTypeError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::UnsupportedLinkTypeError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::UnsupportedLinkTypeError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">UnsupportedLinkTypeError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::UnsupportedLinkTypeError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::UnsupportedLinkTypeError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/UnverifiedDropboxId_html.html b/doc/docs/DropboxApi/Errors/UnverifiedDropboxId_html.html new file mode 100644 index 00000000..4068693f --- /dev/null +++ b/doc/docs/DropboxApi/Errors/UnverifiedDropboxId_html.html @@ -0,0 +1,822 @@ + + + + + + +UnverifiedDropboxId.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::UnverifiedDropboxId
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::UnverifiedDropboxId";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">UnverifiedDropboxId</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::UnverifiedDropboxId
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::UnverifiedDropboxId</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/basic_error.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/UploadError_html.html b/doc/docs/DropboxApi/Errors/UploadError_html.html new file mode 100644 index 00000000..d9b00c19 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/UploadError_html.html @@ -0,0 +1,841 @@ + + + + + + +UploadError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::UploadError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::UploadError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">UploadError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::UploadError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::UploadError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/upload_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="UploadWriteFailedError.html" title="DropboxApi::Errors::UploadWriteFailedError (class)">UploadWriteFailedError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/UploadSessionFinishError_html.html b/doc/docs/DropboxApi/Errors/UploadSessionFinishError_html.html new file mode 100644 index 00000000..b5307bd1 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/UploadSessionFinishError_html.html @@ -0,0 +1,843 @@ + + + + + + +UploadSessionFinishError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::UploadSessionFinishError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::UploadSessionFinishError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">UploadSessionFinishError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::UploadSessionFinishError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::UploadSessionFinishError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/upload_session_finish_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>lookup_failed:</span> <span class='const'><span class='object_link'><a href="UploadSessionLookupError.html" title="DropboxApi::Errors::UploadSessionLookupError (class)">UploadSessionLookupError</a></span></span><span class='comma'>,</span>
+<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span></span><span class='comma'>,</span>
+<span class='label'>too_many_shared_folder_targets:</span> <span class='const'><span class='object_link'><a href="TooManySharedFolderTargetsError.html" title="DropboxApi::Errors::TooManySharedFolderTargetsError (class)">TooManySharedFolderTargetsError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/UploadSessionLookupError_html.html b/doc/docs/DropboxApi/Errors/UploadSessionLookupError_html.html new file mode 100644 index 00000000..92984c1e --- /dev/null +++ b/doc/docs/DropboxApi/Errors/UploadSessionLookupError_html.html @@ -0,0 +1,844 @@ + + + + + + +UploadSessionLookupError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::UploadSessionLookupError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::UploadSessionLookupError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">UploadSessionLookupError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::UploadSessionLookupError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::UploadSessionLookupError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/upload_session_lookup_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>not_found:</span> <span class='const'><span class='object_link'><a href="NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span></span><span class='comma'>,</span>
+<span class='label'>incorrect_offset:</span> <span class='const'><span class='object_link'><a href="UploadSessionOffsetError.html" title="DropboxApi::Errors::UploadSessionOffsetError (class)">UploadSessionOffsetError</a></span></span><span class='comma'>,</span>
+<span class='label'>closed:</span> <span class='const'><span class='object_link'><a href="CursorClosedError.html" title="DropboxApi::Errors::CursorClosedError (class)">CursorClosedError</a></span></span><span class='comma'>,</span>
+<span class='label'>not_closed:</span> <span class='const'><span class='object_link'><a href="CursorNotClosedError.html" title="DropboxApi::Errors::CursorNotClosedError (class)">CursorNotClosedError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/UploadSessionOffsetError_html.html b/doc/docs/DropboxApi/Errors/UploadSessionOffsetError_html.html new file mode 100644 index 00000000..a0c919b6 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/UploadSessionOffsetError_html.html @@ -0,0 +1,886 @@ + + + + + + +UploadSessionOffsetError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::UploadSessionOffsetError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::UploadSessionOffsetError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">UploadSessionOffsetError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::UploadSessionOffsetError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::UploadSessionOffsetError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/upload_session_offset_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(message, metadata)  &#x21d2; UploadSessionOffsetError </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of UploadSessionOffsetError.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(message, metadata)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Errors::UploadSessionOffsetError (class)">UploadSessionOffsetError</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of UploadSessionOffsetError.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/errors/upload_session_offset_error.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_message'>message</span><span +class='comma'>,</span> <span class='id identifier +rubyid_metadata'>metadata</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_content'>, correct offset: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_metadata'>metadata</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>correct_offset</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>super</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='id identifier rubyid_metadata'>metadata</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/UploadWriteFailedError_html.html b/doc/docs/DropboxApi/Errors/UploadWriteFailedError_html.html new file mode 100644 index 00000000..55a4308b --- /dev/null +++ b/doc/docs/DropboxApi/Errors/UploadWriteFailedError_html.html @@ -0,0 +1,841 @@ + + + + + + +UploadWriteFailedError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::UploadWriteFailedError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::UploadWriteFailedError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">UploadWriteFailedError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::UploadWriteFailedError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::UploadWriteFailedError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/upload_write_failed_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>reason:</span> <span class='const'><span class='object_link'><a href="WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span></span>
+ +

<span class='rbrace'>}</span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/WriteConflictError_html.html b/doc/docs/DropboxApi/Errors/WriteConflictError_html.html new file mode 100644 index 00000000..9209b002 --- /dev/null +++ b/doc/docs/DropboxApi/Errors/WriteConflictError_html.html @@ -0,0 +1,841 @@ + + + + + + +WriteConflictError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::WriteConflictError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::WriteConflictError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (W)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">WriteConflictError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::WriteConflictError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::WriteConflictError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/write_conflict_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>file:</span> <span class='const'><span class='object_link'><a href="FileConflictError.html" title="DropboxApi::Errors::FileConflictError (class)">FileConflictError</a></span></span><span class='comma'>,</span>
+<span class='label'>folder:</span> <span class='const'><span class='object_link'><a href="FolderConflictError.html" title="DropboxApi::Errors::FolderConflictError (class)">FolderConflictError</a></span></span><span class='comma'>,</span>
+<span class='label'>file_ancestor:</span> <span class='const'><span class='object_link'><a href="FileAncestorConflictError.html" title="DropboxApi::Errors::FileAncestorConflictError (class)">FileAncestorConflictError</a></span></span>
+ +

<span class='rbrace'>}</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors/WriteError_html.html b/doc/docs/DropboxApi/Errors/WriteError_html.html new file mode 100644 index 00000000..6bc857ed --- /dev/null +++ b/doc/docs/DropboxApi/Errors/WriteError_html.html @@ -0,0 +1,843 @@ + + + + + + +WriteError.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Exception: DropboxApi::Errors::WriteError
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors::WriteError";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (W)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span>
+   &raquo; 
+  <span class="title">WriteError</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Exception: DropboxApi::Errors::WriteError
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">StandardError</li>
+
+          <li class="next"><span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></li>
+
+          <li class="next">DropboxApi::Errors::WriteError</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/write_error.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="ErrorSubtypes-constant" class="">ErrorSubtypes =
+
+      </dt>
+      <dd><pre class="code"><span class='lbrace'>{</span>
+<span class='label'>malformed_path:</span> <span class='const'><span class='object_link'><a href="MalformedPathError.html" title="DropboxApi::Errors::MalformedPathError (class)">MalformedPathError</a></span></span><span class='comma'>,</span>
+<span class='label'>conflict:</span> <span class='const'><span class='object_link'><a href="WriteConflictError.html" title="DropboxApi::Errors::WriteConflictError (class)">WriteConflictError</a></span></span><span class='comma'>,</span>
+<span class='label'>no_write_permission:</span> <span class='const'><span class='object_link'><a href="NoWritePermissionError.html" title="DropboxApi::Errors::NoWritePermissionError (class)">NoWritePermissionError</a></span></span><span class='comma'>,</span>
+<span class='label'>insufficient_space:</span> <span class='const'><span class='object_link'><a href="InsufficientSpaceError.html" title="DropboxApi::Errors::InsufficientSpaceError (class)">InsufficientSpaceError</a></span></span><span class='comma'>,</span>
+<span class='label'>disallowed_name:</span> <span class='const'><span class='object_link'><a href="DisallowedNameError.html" title="DropboxApi::Errors::DisallowedNameError (class)">DisallowedNameError</a></span></span>
+ +

<span class='rbrace'>}</span></pre></dd>

+ +
  </dl>
+
+<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>, <span class='object_link'><a href="BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>, <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span></p>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">DropboxApi::Errors::BasicError</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Errors_html.html b/doc/docs/DropboxApi/Errors_html.html new file mode 100644 index 00000000..f68e26a9 --- /dev/null +++ b/doc/docs/DropboxApi/Errors_html.html @@ -0,0 +1,800 @@ + + + + + + +Errors.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Module: DropboxApi::Errors
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Errors";
+relpath = '../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../_index.html">Index (E)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+   &raquo; 
+  <span class="title">Errors</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Module: DropboxApi::Errors
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/errors/http_error.rb<span class="defines">,<br />
+lib/dropbox_api/errors/poll_error.rb,<br /> lib/dropbox_api/errors/basic_error.rb,<br /> lib/dropbox_api/errors/write_error.rb,<br /> lib/dropbox_api/errors/delete_error.rb,<br /> lib/dropbox_api/errors/lookup_error.rb,<br /> lib/dropbox_api/errors/search_error.rb,<br /> lib/dropbox_api/errors/upload_error.rb,<br /> lib/dropbox_api/errors/preview_error.rb,<br /> lib/dropbox_api/errors/restore_error.rb,<br /> lib/dropbox_api/errors/download_error.rb,<br /> lib/dropbox_api/errors/save_url_error.rb,<br /> lib/dropbox_api/errors/settings_error.rb,<br /> lib/dropbox_api/errors/thumbnail_error.rb,<br /> lib/dropbox_api/errors/relocation_error.rb,<br /> lib/dropbox_api/errors/share_path_error.rb,<br /> lib/dropbox_api/errors/get_account_error.rb,<br /> lib/dropbox_api/errors/list_folder_error.rb,<br /> lib/dropbox_api/errors/shared_link_error.rb,<br /> lib/dropbox_api/errors/get_metadata_error.rb,<br /> lib/dropbox_api/errors/share_folder_error.rb,<br /> lib/dropbox_api/errors/sharing_user_error.rb,<br /> lib/dropbox_api/errors/unshare_file_error.rb,<br /> lib/dropbox_api/errors/create_folder_error.rb,<br /> lib/dropbox_api/errors/already_shared_error.rb,<br /> lib/dropbox_api/errors/list_revisions_error.rb,<br /> lib/dropbox_api/errors/write_conflict_error.rb,<br /> lib/dropbox_api/errors/add_file_member_error.rb,<br /> lib/dropbox_api/errors/thumbnail_batch_error.rb,<br /> lib/dropbox_api/errors/add_folder_member_error.rb,<br /> lib/dropbox_api/errors/list_shared_links_error.rb,<br /> lib/dropbox_api/errors/too_many_requests_error.rb,<br /> lib/dropbox_api/errors/file_member_action_error.rb,<br /> lib/dropbox_api/errors/get_copy_reference_error.rb,<br /> lib/dropbox_api/errors/revoke_shared_link_error.rb,<br /> lib/dropbox_api/errors/add_member_selector_error.rb,<br /> lib/dropbox_api/errors/create_file_request_error.rb,<br /> lib/dropbox_api/errors/create_folder_batch_error.rb,<br /> lib/dropbox_api/errors/save_copy_reference_error.rb,<br /> lib/dropbox_api/errors/sharing_file_access_error.rb,<br /> lib/dropbox_api/errors/upload_write_failed_error.rb,<br /> lib/dropbox_api/errors/expired_access_token_error.rb,<br /> lib/dropbox_api/errors/list_folder_continue_error.rb,<br /> lib/dropbox_api/errors/list_folder_longpoll_error.rb,<br /> lib/dropbox_api/errors/shared_folder_access_error.rb,<br /> lib/dropbox_api/errors/upload_session_finish_error.rb,<br /> lib/dropbox_api/errors/upload_session_lookup_error.rb,<br /> lib/dropbox_api/errors/upload_session_offset_error.rb,<br /> lib/dropbox_api/errors/relocation_batch_entry_error.rb,<br /> lib/dropbox_api/errors/create_shared_link_with_settings_error.rb</span>
+ +

</dd>

+ +
</dl>
+ +

</div>

+ +

<h2>Defined Under Namespace</h2> <p class=“children”>

+ +
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Errors/AddFileMemberError.html" title="DropboxApi::Errors::AddFileMemberError (class)">AddFileMemberError</a></span>, <span class='object_link'><a href="Errors/AddFolderMemberError.html" title="DropboxApi::Errors::AddFolderMemberError (class)">AddFolderMemberError</a></span>, <span class='object_link'><a href="Errors/AddMemberSelectorError.html" title="DropboxApi::Errors::AddMemberSelectorError (class)">AddMemberSelectorError</a></span>, <span class='object_link'><a href="Errors/AlreadySharedError.html" title="DropboxApi::Errors::AlreadySharedError (class)">AlreadySharedError</a></span>, <span class='object_link'><a href="Errors/BadPathError.html" title="DropboxApi::Errors::BadPathError (class)">BadPathError</a></span>, <span class='object_link'><a href="Errors/BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span>, <span class='object_link'><a href="Errors/CantCopySharedFolderError.html" title="DropboxApi::Errors::CantCopySharedFolderError (class)">CantCopySharedFolderError</a></span>, <span class='object_link'><a href="Errors/CantMoveFolderIntoItselfError.html" title="DropboxApi::Errors::CantMoveFolderIntoItselfError (class)">CantMoveFolderIntoItselfError</a></span>, <span class='object_link'><a href="Errors/CantNestSharedFolderError.html" title="DropboxApi::Errors::CantNestSharedFolderError (class)">CantNestSharedFolderError</a></span>, <span class='object_link'><a href="Errors/CantShareOutsideTeamError.html" title="DropboxApi::Errors::CantShareOutsideTeamError (class)">CantShareOutsideTeamError</a></span>, <span class='object_link'><a href="Errors/ContainsSharedFolderError.html" title="DropboxApi::Errors::ContainsSharedFolderError (class)">ContainsSharedFolderError</a></span>, <span class='object_link'><a href="Errors/ConversionError.html" title="DropboxApi::Errors::ConversionError (class)">ConversionError</a></span>, <span class='object_link'><a href="Errors/CreateFileRequestError.html" title="DropboxApi::Errors::CreateFileRequestError (class)">CreateFileRequestError</a></span>, <span class='object_link'><a href="Errors/CreateFolderBatchError.html" title="DropboxApi::Errors::CreateFolderBatchError (class)">CreateFolderBatchError</a></span>, <span class='object_link'><a href="Errors/CreateFolderError.html" title="DropboxApi::Errors::CreateFolderError (class)">CreateFolderError</a></span>, <span class='object_link'><a href="Errors/CreateSharedLinkWithSettingsError.html" title="DropboxApi::Errors::CreateSharedLinkWithSettingsError (class)">CreateSharedLinkWithSettingsError</a></span>, <span class='object_link'><a href="Errors/CursorClosedError.html" title="DropboxApi::Errors::CursorClosedError (class)">CursorClosedError</a></span>, <span class='object_link'><a href="Errors/CursorNotClosedError.html" title="DropboxApi::Errors::CursorNotClosedError (class)">CursorNotClosedError</a></span>, <span class='object_link'><a href="Errors/DeleteError.html" title="DropboxApi::Errors::DeleteError (class)">DeleteError</a></span>, <span class='object_link'><a href="Errors/DisallowedNameError.html" title="DropboxApi::Errors::DisallowedNameError (class)">DisallowedNameError</a></span>, <span class='object_link'><a href="Errors/DisallowedSharedLinkPolicyError.html" title="DropboxApi::Errors::DisallowedSharedLinkPolicyError (class)">DisallowedSharedLinkPolicyError</a></span>, <span class='object_link'><a href="Errors/DownloadError.html" title="DropboxApi::Errors::DownloadError (class)">DownloadError</a></span>, <span class='object_link'><a href="Errors/DownloadFailedError.html" title="DropboxApi::Errors::DownloadFailedError (class)">DownloadFailedError</a></span>, <span class='object_link'><a href="Errors/EmailUnverifiedError.html" title="DropboxApi::Errors::EmailUnverifiedError (class)">EmailUnverifiedError</a></span>, <span class='object_link'><a href="Errors/ExpiredAccessTokenError.html" title="DropboxApi::Errors::ExpiredAccessTokenError (class)">ExpiredAccessTokenError</a></span>, <span class='object_link'><a href="Errors/FileAncestorConflictError.html" title="DropboxApi::Errors::FileAncestorConflictError (class)">FileAncestorConflictError</a></span>, <span class='object_link'><a href="Errors/FileConflictError.html" title="DropboxApi::Errors::FileConflictError (class)">FileConflictError</a></span>, <span class='object_link'><a href="Errors/FileMemberActionError.html" title="DropboxApi::Errors::FileMemberActionError (class)">FileMemberActionError</a></span>, <span class='object_link'><a href="Errors/FolderConflictError.html" title="DropboxApi::Errors::FolderConflictError (class)">FolderConflictError</a></span>, <span class='object_link'><a href="Errors/GetAccountError.html" title="DropboxApi::Errors::GetAccountError (class)">GetAccountError</a></span>, <span class='object_link'><a href="Errors/GetCopyReferenceError.html" title="DropboxApi::Errors::GetCopyReferenceError (class)">GetCopyReferenceError</a></span>, <span class='object_link'><a href="Errors/GetMetadataError.html" title="DropboxApi::Errors::GetMetadataError (class)">GetMetadataError</a></span>, <span class='object_link'><a href="Errors/GroupDeletedError.html" title="DropboxApi::Errors::GroupDeletedError (class)">GroupDeletedError</a></span>, <span class='object_link'><a href="Errors/GroupNotOnTeamError.html" title="DropboxApi::Errors::GroupNotOnTeamError (class)">GroupNotOnTeamError</a></span>, <span class='object_link'><a href="Errors/HttpError.html" title="DropboxApi::Errors::HttpError (class)">HttpError</a></span>, <span class='object_link'><a href="Errors/InProgressError.html" title="DropboxApi::Errors::InProgressError (class)">InProgressError</a></span>, <span class='object_link'><a href="Errors/InsideAppFolderError.html" title="DropboxApi::Errors::InsideAppFolderError (class)">InsideAppFolderError</a></span>, <span class='object_link'><a href="Errors/InsideOsxPackageError.html" title="DropboxApi::Errors::InsideOsxPackageError (class)">InsideOsxPackageError</a></span>, <span class='object_link'><a href="Errors/InsidePublicFolderError.html" title="DropboxApi::Errors::InsidePublicFolderError (class)">InsidePublicFolderError</a></span>, <span class='object_link'><a href="Errors/InsideSharedFolderError.html" title="DropboxApi::Errors::InsideSharedFolderError (class)">InsideSharedFolderError</a></span>, <span class='object_link'><a href="Errors/InsufficientPlanError.html" title="DropboxApi::Errors::InsufficientPlanError (class)">InsufficientPlanError</a></span>, <span class='object_link'><a href="Errors/InsufficientSpaceError.html" title="DropboxApi::Errors::InsufficientSpaceError (class)">InsufficientSpaceError</a></span>, <span class='object_link'><a href="Errors/InternalError.html" title="DropboxApi::Errors::InternalError (class)">InternalError</a></span>, <span class='object_link'><a href="Errors/InvalidCommentError.html" title="DropboxApi::Errors::InvalidCommentError (class)">InvalidCommentError</a></span>, <span class='object_link'><a href="Errors/InvalidCopyReferenceError.html" title="DropboxApi::Errors::InvalidCopyReferenceError (class)">InvalidCopyReferenceError</a></span>, <span class='object_link'><a href="Errors/InvalidCursorError.html" title="DropboxApi::Errors::InvalidCursorError (class)">InvalidCursorError</a></span>, <span class='object_link'><a href="Errors/InvalidDropboxIdError.html" title="DropboxApi::Errors::InvalidDropboxIdError (class)">InvalidDropboxIdError</a></span>, <span class='object_link'><a href="Errors/InvalidEmailError.html" title="DropboxApi::Errors::InvalidEmailError (class)">InvalidEmailError</a></span>, <span class='object_link'><a href="Errors/InvalidFileError.html" title="DropboxApi::Errors::InvalidFileError (class)">InvalidFileError</a></span>, <span class='object_link'><a href="Errors/InvalidIdError.html" title="DropboxApi::Errors::InvalidIdError (class)">InvalidIdError</a></span>, <span class='object_link'><a href="Errors/InvalidMemberError.html" title="DropboxApi::Errors::InvalidMemberError (class)">InvalidMemberError</a></span>, <span class='object_link'><a href="Errors/InvalidPathError.html" title="DropboxApi::Errors::InvalidPathError (class)">InvalidPathError</a></span>, <span class='object_link'><a href="Errors/InvalidRevisionError.html" title="DropboxApi::Errors::InvalidRevisionError (class)">InvalidRevisionError</a></span>, <span class='object_link'><a href="Errors/InvalidSettingsError.html" title="DropboxApi::Errors::InvalidSettingsError (class)">InvalidSettingsError</a></span>, <span class='object_link'><a href="Errors/InvalidUrlError.html" title="DropboxApi::Errors::InvalidUrlError (class)">InvalidUrlError</a></span>, <span class='object_link'><a href="Errors/IsAppFolderError.html" title="DropboxApi::Errors::IsAppFolderError (class)">IsAppFolderError</a></span>, <span class='object_link'><a href="Errors/IsFileError.html" title="DropboxApi::Errors::IsFileError (class)">IsFileError</a></span>, <span class='object_link'><a href="Errors/IsFolderError.html" title="DropboxApi::Errors::IsFolderError (class)">IsFolderError</a></span>, <span class='object_link'><a href="Errors/IsOsxPackageError.html" title="DropboxApi::Errors::IsOsxPackageError (class)">IsOsxPackageError</a></span>, <span class='object_link'><a href="Errors/IsPublicFolderError.html" title="DropboxApi::Errors::IsPublicFolderError (class)">IsPublicFolderError</a></span>, <span class='object_link'><a href="Errors/ListFolderContinueError.html" title="DropboxApi::Errors::ListFolderContinueError (class)">ListFolderContinueError</a></span>, <span class='object_link'><a href="Errors/ListFolderError.html" title="DropboxApi::Errors::ListFolderError (class)">ListFolderError</a></span>, <span class='object_link'><a href="Errors/ListFolderLongpollError.html" title="DropboxApi::Errors::ListFolderLongpollError (class)">ListFolderLongpollError</a></span>, <span class='object_link'><a href="Errors/ListRevisionsError.html" title="DropboxApi::Errors::ListRevisionsError (class)">ListRevisionsError</a></span>, <span class='object_link'><a href="Errors/ListSharedLinksError.html" title="DropboxApi::Errors::ListSharedLinksError (class)">ListSharedLinksError</a></span>, <span class='object_link'><a href="Errors/LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span>, <span class='object_link'><a href="Errors/MalformedPathError.html" title="DropboxApi::Errors::MalformedPathError (class)">MalformedPathError</a></span>, <span class='object_link'><a href="Errors/NoAccountError.html" title="DropboxApi::Errors::NoAccountError (class)">NoAccountError</a></span>, <span class='object_link'><a href="Errors/NoPermissionError.html" title="DropboxApi::Errors::NoPermissionError (class)">NoPermissionError</a></span>, <span class='object_link'><a href="Errors/NoWritePermissionError.html" title="DropboxApi::Errors::NoWritePermissionError (class)">NoWritePermissionError</a></span>, <span class='object_link'><a href="Errors/NotAMemberError.html" title="DropboxApi::Errors::NotAMemberError (class)">NotAMemberError</a></span>, <span class='object_link'><a href="Errors/NotFileError.html" title="DropboxApi::Errors::NotFileError (class)">NotFileError</a></span>, <span class='object_link'><a href="Errors/NotFolderError.html" title="DropboxApi::Errors::NotFolderError (class)">NotFolderError</a></span>, <span class='object_link'><a href="Errors/NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span>, <span class='object_link'><a href="Errors/PollError.html" title="DropboxApi::Errors::PollError (class)">PollError</a></span>, <span class='object_link'><a href="Errors/PreviewError.html" title="DropboxApi::Errors::PreviewError (class)">PreviewError</a></span>, <span class='object_link'><a href="Errors/RateLimitError.html" title="DropboxApi::Errors::RateLimitError (class)">RateLimitError</a></span>, <span class='object_link'><a href="Errors/RelocationBatchEntryError.html" title="DropboxApi::Errors::RelocationBatchEntryError (class)">RelocationBatchEntryError</a></span>, <span class='object_link'><a href="Errors/RelocationError.html" title="DropboxApi::Errors::RelocationError (class)">RelocationError</a></span>, <span class='object_link'><a href="Errors/RestoreError.html" title="DropboxApi::Errors::RestoreError (class)">RestoreError</a></span>, <span class='object_link'><a href="Errors/RestrictedContentError.html" title="DropboxApi::Errors::RestrictedContentError (class)">RestrictedContentError</a></span>, <span class='object_link'><a href="Errors/RevokeSharedLinkError.html" title="DropboxApi::Errors::RevokeSharedLinkError (class)">RevokeSharedLinkError</a></span>, <span class='object_link'><a href="Errors/SaveCopyReferenceError.html" title="DropboxApi::Errors::SaveCopyReferenceError (class)">SaveCopyReferenceError</a></span>, <span class='object_link'><a href="Errors/SaveUrlError.html" title="DropboxApi::Errors::SaveUrlError (class)">SaveUrlError</a></span>, <span class='object_link'><a href="Errors/SearchError.html" title="DropboxApi::Errors::SearchError (class)">SearchError</a></span>, <span class='object_link'><a href="Errors/SettingsError.html" title="DropboxApi::Errors::SettingsError (class)">SettingsError</a></span>, <span class='object_link'><a href="Errors/ShareFolderError.html" title="DropboxApi::Errors::ShareFolderError (class)">ShareFolderError</a></span>, <span class='object_link'><a href="Errors/SharePathError.html" title="DropboxApi::Errors::SharePathError (class)">SharePathError</a></span>, <span class='object_link'><a href="Errors/SharedFolderAccessError.html" title="DropboxApi::Errors::SharedFolderAccessError (class)">SharedFolderAccessError</a></span>, <span class='object_link'><a href="Errors/SharedLinkAccessDeniedError.html" title="DropboxApi::Errors::SharedLinkAccessDeniedError (class)">SharedLinkAccessDeniedError</a></span>, <span class='object_link'><a href="Errors/SharedLinkAlreadyExistsError.html" title="DropboxApi::Errors::SharedLinkAlreadyExistsError (class)">SharedLinkAlreadyExistsError</a></span>, <span class='object_link'><a href="Errors/SharedLinkError.html" title="DropboxApi::Errors::SharedLinkError (class)">SharedLinkError</a></span>, <span class='object_link'><a href="Errors/SharedLinkMalformedError.html" title="DropboxApi::Errors::SharedLinkMalformedError (class)">SharedLinkMalformedError</a></span>, <span class='object_link'><a href="Errors/SharedLinkNotFoundError.html" title="DropboxApi::Errors::SharedLinkNotFoundError (class)">SharedLinkNotFoundError</a></span>, <span class='object_link'><a href="Errors/SharingFileAccessError.html" title="DropboxApi::Errors::SharingFileAccessError (class)">SharingFileAccessError</a></span>, <span class='object_link'><a href="Errors/SharingUserError.html" title="DropboxApi::Errors::SharingUserError (class)">SharingUserError</a></span>, <span class='object_link'><a href="Errors/TeamFolderError.html" title="DropboxApi::Errors::TeamFolderError (class)">TeamFolderError</a></span>, <span class='object_link'><a href="Errors/TeamPolicyDisallowsMemberPolicyError.html" title="DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError (class)">TeamPolicyDisallowsMemberPolicyError</a></span>, <span class='object_link'><a href="Errors/ThumbnailBatchError.html" title="DropboxApi::Errors::ThumbnailBatchError (class)">ThumbnailBatchError</a></span>, <span class='object_link'><a href="Errors/ThumbnailError.html" title="DropboxApi::Errors::ThumbnailError (class)">ThumbnailError</a></span>, <span class='object_link'><a href="Errors/TooManyFilesError.html" title="DropboxApi::Errors::TooManyFilesError (class)">TooManyFilesError</a></span>, <span class='object_link'><a href="Errors/TooManyMembersError.html" title="DropboxApi::Errors::TooManyMembersError (class)">TooManyMembersError</a></span>, <span class='object_link'><a href="Errors/TooManyPendingInvitesError.html" title="DropboxApi::Errors::TooManyPendingInvitesError (class)">TooManyPendingInvitesError</a></span>, <span class='object_link'><a href="Errors/TooManyRequestsError.html" title="DropboxApi::Errors::TooManyRequestsError (class)">TooManyRequestsError</a></span>, <span class='object_link'><a href="Errors/TooManySharedFolderTargetsError.html" title="DropboxApi::Errors::TooManySharedFolderTargetsError (class)">TooManySharedFolderTargetsError</a></span>, <span class='object_link'><a href="Errors/TooManyWriteOperationsError.html" title="DropboxApi::Errors::TooManyWriteOperationsError (class)">TooManyWriteOperationsError</a></span>, <span class='object_link'><a href="Errors/UnmountedError.html" title="DropboxApi::Errors::UnmountedError (class)">UnmountedError</a></span>, <span class='object_link'><a href="Errors/UnshareFileError.html" title="DropboxApi::Errors::UnshareFileError (class)">UnshareFileError</a></span>, <span class='object_link'><a href="Errors/UnsupportedContentError.html" title="DropboxApi::Errors::UnsupportedContentError (class)">UnsupportedContentError</a></span>, <span class='object_link'><a href="Errors/UnsupportedExtensionError.html" title="DropboxApi::Errors::UnsupportedExtensionError (class)">UnsupportedExtensionError</a></span>, <span class='object_link'><a href="Errors/UnsupportedImageError.html" title="DropboxApi::Errors::UnsupportedImageError (class)">UnsupportedImageError</a></span>, <span class='object_link'><a href="Errors/UnsupportedLinkTypeError.html" title="DropboxApi::Errors::UnsupportedLinkTypeError (class)">UnsupportedLinkTypeError</a></span>, <span class='object_link'><a href="Errors/UnverifiedDropboxId.html" title="DropboxApi::Errors::UnverifiedDropboxId (class)">UnverifiedDropboxId</a></span>, <span class='object_link'><a href="Errors/UploadError.html" title="DropboxApi::Errors::UploadError (class)">UploadError</a></span>, <span class='object_link'><a href="Errors/UploadSessionFinishError.html" title="DropboxApi::Errors::UploadSessionFinishError (class)">UploadSessionFinishError</a></span>, <span class='object_link'><a href="Errors/UploadSessionLookupError.html" title="DropboxApi::Errors::UploadSessionLookupError (class)">UploadSessionLookupError</a></span>, <span class='object_link'><a href="Errors/UploadSessionOffsetError.html" title="DropboxApi::Errors::UploadSessionOffsetError (class)">UploadSessionOffsetError</a></span>, <span class='object_link'><a href="Errors/UploadWriteFailedError.html" title="DropboxApi::Errors::UploadWriteFailedError (class)">UploadWriteFailedError</a></span>, <span class='object_link'><a href="Errors/WriteConflictError.html" title="DropboxApi::Errors::WriteConflictError (class)">WriteConflictError</a></span>, <span class='object_link'><a href="Errors/WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span>
+ +

</p>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/AccessLevel_html.html b/doc/docs/DropboxApi/Metadata/AccessLevel_html.html new file mode 100644 index 00000000..7a711b50 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/AccessLevel_html.html @@ -0,0 +1,917 @@ + + + + + + +AccessLevel.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::AccessLevel
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::AccessLevel";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (A)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">AccessLevel</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::AccessLevel
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::AccessLevel</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/access_level.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::AccessLevel (class)">AccessLevel</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;: &quot;viewer&quot;
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="VALID_ACCESS_LEVELS-constant" class="">VALID_ACCESS_LEVELS =
+
+      </dt>
+      <dd><pre class="code"><span class='lbracket'>[</span>
+<span class='symbol'>:owner</span><span class='comma'>,</span>
+<span class='symbol'>:editor</span><span class='comma'>,</span>
+<span class='symbol'>:viewer</span><span class='comma'>,</span>
+<span class='symbol'>:viewer_no_comment</span>
+ +

<span class='rbracket'>]</span></pre></dd>

+ +
  </dl>
+
+  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#valid_values-class_method" title="valid_values (class method)">.<strong>valid_values</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Tag.html#new-class_method" title="DropboxApi::Metadata::Tag.new (method)">new</a></span>, <span class='object_link'><a href="Tag.html#validate-class_method" title="DropboxApi::Metadata::Tag.validate (method)">validate</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="valid_values-class_method">
+
+  .<strong>valid_values</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/access_level.rb', line 18</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_valid_values'>valid_values</span>

+ +
<span class='const'><span class='object_link'><a href="#VALID_ACCESS_LEVELS-constant" title="DropboxApi::Metadata::AccessLevel::VALID_ACCESS_LEVELS (constant)">VALID_ACCESS_LEVELS</a></span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/AddFileMemberResult_html.html b/doc/docs/DropboxApi/Metadata/AddFileMemberResult_html.html new file mode 100644 index 00000000..b149dae8 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/AddFileMemberResult_html.html @@ -0,0 +1,847 @@ + + + + + + +AddFileMemberResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::AddFileMemberResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::AddFileMemberResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (A)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">AddFileMemberResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::AddFileMemberResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::AddFileMemberResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/add_file_member_result.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a <span class='object_link'><a href="" title="DropboxApi::Metadata::AddFileMemberResult (class)">AddFileMemberResult</a></span>:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;member&quot;:{
+  &quot;.tag&quot;: &quot;email&quot;,
+  &quot;email&quot;: &quot;somebody@test.com&quot;
+},
+&quot;result&quot;: {
+  &quot;.tag&quot;: &quot;success&quot;,
+  &quot;success&quot;: {
+    &quot;.tag&quot;: &quot;viewer&quot;
+  }
+}
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/AddMember_html.html b/doc/docs/DropboxApi/Metadata/AddMember_html.html new file mode 100644 index 00000000..97dbf417 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/AddMember_html.html @@ -0,0 +1,917 @@ + + + + + + +AddMember.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::AddMember
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::AddMember";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (A)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">AddMember</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::AddMember
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::AddMember</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/add_member.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Examples of serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::AddMember (class)">AddMember</a></span> objects:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;member&quot;: {
+  &quot;.tag&quot;: &quot;email&quot;,
+  &quot;email&quot;: &quot;justin@example.com&quot;
+},
+&quot;access_level&quot;: {
+  &quot;.tag&quot;: &quot;editor&quot;
+}
+ +

}, {

+ +
&quot;member&quot;: {
+  &quot;.tag&quot;: &quot;dropbox_id&quot;,
+  &quot;dropbox_id&quot;: &quot;dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q&quot;
+},
+&quot;access_level&quot;: {
+  &quot;.tag&quot;: &quot;viewer&quot;
+}
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_from_string-class_method" title="build_from_string (class method)">.<strong>build_from_string</strong>(member, access_level = :editor)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build_from_string-class_method">
+
+  .<strong>build_from_string</strong>(member, access_level = :editor)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

27 28 29 30 31 32</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/add_member.rb', line 27</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_build_from_string'>build_from_string</span><span +class='lparen'>(</span><span class='id identifier +rubyid_member'>member</span><span +class='comma'>,</span> <span class='id identifier +rubyid_access_level'>access_level</span> <span +class='op'>=</span> <span +class='symbol'>:editor</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>member</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='const'><span class='object_link'><a href="Member.html" title="DropboxApi::Metadata::Member (class)">Member</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Member.html#initialize-instance_method" title="DropboxApi::Metadata::Member#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_member'>member</span><span class='rparen'>)</span><span class='comma'>,</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>access_level</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_access_level'>access_level</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/Base_html.html b/doc/docs/DropboxApi/Metadata/Base_html.html new file mode 100644 index 00000000..ac5dc9bb --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/Base_html.html @@ -0,0 +1,1177 @@ + + + + + + +Base.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::Base
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::Base";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (B)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">Base</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::Base
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::Metadata::Base</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/base.rb</dd>
+</dl>
+ +

</div>

+ +

<div id=“subclasses”>

+ +
<h2>Direct Known Subclasses</h2>
+<p class="children"><span class='object_link'><a href="AddFileMemberResult.html" title="DropboxApi::Metadata::AddFileMemberResult (class)">AddFileMemberResult</a></span>, <span class='object_link'><a href="AddMember.html" title="DropboxApi::Metadata::AddMember (class)">AddMember</a></span>, <span class='object_link'><a href="BasicAccount.html" title="DropboxApi::Metadata::BasicAccount (class)">BasicAccount</a></span>, <span class='object_link'><a href="CommitInfo.html" title="DropboxApi::Metadata::CommitInfo (class)">CommitInfo</a></span>, <span class='object_link'><a href="Deleted.html" title="DropboxApi::Metadata::Deleted (class)">Deleted</a></span>, <span class='object_link'><a href="Dimensions.html" title="DropboxApi::Metadata::Dimensions (class)">Dimensions</a></span>, <span class='object_link'><a href="File.html" title="DropboxApi::Metadata::File (class)">File</a></span>, <span class='object_link'><a href="FileLinkMetadata.html" title="DropboxApi::Metadata::FileLinkMetadata (class)">FileLinkMetadata</a></span>, <span class='object_link'><a href="FileMemberAction.html" title="DropboxApi::Metadata::FileMemberAction (class)">FileMemberAction</a></span>, <span class='object_link'><a href="FileRequest.html" title="DropboxApi::Metadata::FileRequest (class)">FileRequest</a></span>, <span class='object_link'><a href="Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span>, <span class='object_link'><a href="FolderLinkMetadata.html" title="DropboxApi::Metadata::FolderLinkMetadata (class)">FolderLinkMetadata</a></span>, <span class='object_link'><a href="FolderSharingInfo.html" title="DropboxApi::Metadata::FolderSharingInfo (class)">FolderSharingInfo</a></span>, <span class='object_link'><a href="LinkPermissions.html" title="DropboxApi::Metadata::LinkPermissions (class)">LinkPermissions</a></span>, <span class='object_link'><a href="Location.html" title="DropboxApi::Metadata::Location (class)">Location</a></span>, <span class='object_link'><a href="MediaInfo.html" title="DropboxApi::Metadata::MediaInfo (class)">MediaInfo</a></span>, <span class='object_link'><a href="MediaMetadata.html" title="DropboxApi::Metadata::MediaMetadata (class)">MediaMetadata</a></span>, <span class='object_link'><a href="Member.html" title="DropboxApi::Metadata::Member (class)">Member</a></span>, <span class='object_link'><a href="MemberPermission.html" title="DropboxApi::Metadata::MemberPermission (class)">MemberPermission</a></span>, <span class='object_link'><a href="MetadataV2.html" title="DropboxApi::Metadata::MetadataV2 (class)">MetadataV2</a></span>, <span class='object_link'><a href="Name.html" title="DropboxApi::Metadata::Name (class)">Name</a></span>, <span class='object_link'><a href="NamespaceId.html" title="DropboxApi::Metadata::NamespaceId (class)">NamespaceId</a></span>, <span class='object_link'><a href="ParentFolderAccessInfo.html" title="DropboxApi::Metadata::ParentFolderAccessInfo (class)">ParentFolderAccessInfo</a></span>, <span class='object_link'><a href="PhotoMetadata.html" title="DropboxApi::Metadata::PhotoMetadata (class)">PhotoMetadata</a></span>, <span class='object_link'><a href="RootInfo.html" title="DropboxApi::Metadata::RootInfo (class)">RootInfo</a></span>, <span class='object_link'><a href="SearchMatchFieldOptions.html" title="DropboxApi::Metadata::SearchMatchFieldOptions (class)">SearchMatchFieldOptions</a></span>, <span class='object_link'><a href="SearchMatchV2.html" title="DropboxApi::Metadata::SearchMatchV2 (class)">SearchMatchV2</a></span>, <span class='object_link'><a href="SearchOptions.html" title="DropboxApi::Metadata::SearchOptions (class)">SearchOptions</a></span>, <span class='object_link'><a href="SharedFolder.html" title="DropboxApi::Metadata::SharedFolder (class)">SharedFolder</a></span>, <span class='object_link'><a href="SharedFolderPolicy.html" title="DropboxApi::Metadata::SharedFolderPolicy (class)">SharedFolderPolicy</a></span>, <span class='object_link'><a href="SharedLink.html" title="DropboxApi::Metadata::SharedLink (class)">SharedLink</a></span>, <span class='object_link'><a href="SpaceAllocation.html" title="DropboxApi::Metadata::SpaceAllocation (class)">SpaceAllocation</a></span>, <span class='object_link'><a href="SpaceUsage.html" title="DropboxApi::Metadata::SpaceUsage (class)">SpaceUsage</a></span>, <span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span>, <span class='object_link'><a href="Team.html" title="DropboxApi::Metadata::Team (class)">Team</a></span>, <span class='object_link'><a href="TeamMemberInfo.html" title="DropboxApi::Metadata::TeamMemberInfo (class)">TeamMemberInfo</a></span>, <span class='object_link'><a href="TeamRootInfo.html" title="DropboxApi::Metadata::TeamRootInfo (class)">TeamRootInfo</a></span>, <span class='object_link'><a href="ThumbnailBatchResultData.html" title="DropboxApi::Metadata::ThumbnailBatchResultData (class)">ThumbnailBatchResultData</a></span>, <span class='object_link'><a href="UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">UploadSessionCursor</a></span>, <span class='object_link'><a href="UserRootInfo.html" title="DropboxApi::Metadata::UserRootInfo (class)">UserRootInfo</a></span>, <span class='object_link'><a href="VideoMetadata.html" title="DropboxApi::Metadata::VideoMetadata (class)">VideoMetadata</a></span>, <span class='object_link'><a href="WriteMode.html" title="DropboxApi::Metadata::WriteMode (class)">WriteMode</a></span></p>
+ +

</div>

+ +
<h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+<ul class="summary">
+
+    <li class="public ">
+<span class="summary_signature">
+
+    <a href="#fields-class_method" title="fields (class method)">.<strong>fields</strong>  &#x21d2; Object </a>
+
+</span>
+
+    <span class="note title readonly">readonly</span>
+
+  <span class="summary_desc"><div class='inline'><p>Returns the value of attribute fields.</p>
+ +

</div></span>

+ +

</li>

+ +
</ul>
+
+  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#field-class_method" title="field (class method)">.<strong>field</strong>(name, type, *options)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(metadata)  &#x21d2; Base </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>Takes in a hash containing all the attributes required to initialize the object.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#serialized_field-instance_method" title="#serialized_field (instance method)">#<strong>serialized_field</strong>(field_name)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#to_hash-instance_method" title="#to_hash (instance method)">#<strong>to_hash</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
</ul>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(metadata)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Metadata::Base (class)">Base</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Takes in a hash containing all the attributes required to initialize the
+ +

object.</p>

+ +

<p>Each hash entry should have a key which identifies a field and its +value, so a valid call would be something like this:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='const'><span class='object_link'><a +href=“../../DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“../Metadata.html” title=“DropboxApi::Metadata +(module)”>Metadata</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“File.html” title=“DropboxApi::Metadata::File +(class)”>File</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='lparen'>(</span><span +class='lbrace'>{</span>

+ +
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>name</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>a.jpg</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>path_lower</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/a.jpg</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>path_display</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/a.jpg</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>id</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>id:evvfE6q6cK0AAAAAAAAB2w</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>client_modified</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>2016-10-19T17:17:34Z</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>server_modified</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>2016-10-19T17:17:34Z</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>rev</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>28924061bdd</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>size</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='int'>396317</span>
+ +

<span class='rbrace'>}</span><span +class='rparen'>)</span> </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>metadata</span>
+
+    <span class='type'>(<tt>Hash</tt>)</span>
+
+</li>
+ +

</ul>

+ +

<p class=“tag_title”>Raises:</p> <ul class=“raise”>

+ +
<li>
+
+    <span class='type'>(<tt>ArgumentError</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>If a required attribute is missing.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

34 35 36 37 38</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/base.rb', line 34</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_metadata'>metadata</span><span +class='rparen'>)</span>

+ +
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_fields'>fields</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_field_name'>field_name</span><span class='op'>|</span>
+  <span class='kw'>self</span><span class='lbracket'>[</span><span class='id identifier rubyid_field_name'>field_name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='lbracket'>[</span><span class='id identifier rubyid_field_name'>field_name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbracket'>]</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="class_attr_details" class="attr_details">
+  <h2>Class Attribute Details</h2>
+
+    <span id=""></span>
+    <div class="method_details first">
+<h3 class="signature first" id="fields-class_method">
+
+  .<strong>fields</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns the value of attribute fields.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

5 6 7</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/base.rb', line 5</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_fields'>fields</span>

+ +
<span class='ivar'>@fields</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+
+<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="field-class_method">
+
+  .<strong>field</strong>(name, type, *options)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

7 8 9 10 11 12</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/base.rb', line 7</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_field'>field</span><span +class='lparen'>(</span><span class='id identifier +rubyid_name'>name</span><span +class='comma'>,</span> <span class='id identifier +rubyid_type'>type</span><span +class='comma'>,</span> <span +class='op'>*</span><span class='id identifier +rubyid_options'>options</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@fields</span> <span class='op'>||=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+<span class='ivar'>@fields</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Field.html" title="DropboxApi::Metadata::Field (class)">Field</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Field.html#initialize-instance_method" title="DropboxApi::Metadata::Field#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='id identifier rubyid_name'>name</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+
+<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="serialized_field-instance_method">
+
+  #<strong>serialized_field</strong>(field_name)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

46 47 48 49 50 51 52 53 54 55 56</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/base.rb', line 46</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_serialized_field'>serialized_field</span><span +class='lparen'>(</span><span class='id identifier +rubyid_field_name'>field_name</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='id identifier rubyid_send'>send</span> <span class='id identifier rubyid_field_name'>field_name</span>
+<span class='kw'>case</span> <span class='id identifier rubyid_value'>value</span>
+<span class='kw'>when</span> <span class='const'>Time</span>
+  <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_utc'>utc</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%FT%TZ</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='kw'>when</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+  <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_value'>value</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="to_hash-instance_method">
+
+  #<strong>to_hash</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

40 41 42 43 44</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/base.rb', line 40</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_to_hash'>to_hash</span>

+ +
<span class='const'>Hash</span><span class='lbracket'>[</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_fields'>fields</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_field_name'>field_name</span><span class='op'>|</span>
+  <span class='lbracket'>[</span><span class='id identifier rubyid_field_name'>field_name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='id identifier rubyid_serialized_field'>serialized_field</span><span class='lparen'>(</span><span class='id identifier rubyid_field_name'>field_name</span><span class='rparen'>)</span><span class='rbracket'>]</span>
+<span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='op'>!</span><span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='rbrace'>}</span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/BasicAccount_html.html b/doc/docs/DropboxApi/Metadata/BasicAccount_html.html new file mode 100644 index 00000000..30726a7a --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/BasicAccount_html.html @@ -0,0 +1,855 @@ + + + + + + +BasicAccount.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::BasicAccount
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::BasicAccount";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (B)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">BasicAccount</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::BasicAccount
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::BasicAccount</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/basic_account.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::BasicAccount (class)">BasicAccount</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;account_id&quot;: &quot;dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc&quot;,
+&quot;name&quot;: {
+    &quot;given_name&quot;: &quot;Franz&quot;,
+    &quot;surname&quot;: &quot;Ferdinand&quot;,
+    &quot;familiar_name&quot;: &quot;Franz&quot;,
+    &quot;display_name&quot;: &quot;Franz Ferdinand (Personal)&quot;
+},
+&quot;email&quot;: &quot;franz@dropbox.com&quot;,
+&quot;email_verified&quot;: true,
+&quot;disabled&quot;: false,
+&quot;is_teammate&quot;: true,
+&quot;profile_photo_url&quot;: &quot;https://dl-web.dropbox.com/account_photo/get/dbid%3AAAH4f99T0taONIb-OurWxbNQ6ywGRopQngc?vers=1453416696524&amp;size=128x128&quot;,
+&quot;team_member_id&quot;: &quot;dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU&quot;,
+&quot;root_info&quot;: {
+  root_namespace_id: 7,
+  home_namespace_id: 1,
+  home_path: &quot;/Franz Ferdinand&quot;
+}
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/CommitInfo_html.html b/doc/docs/DropboxApi/Metadata/CommitInfo_html.html new file mode 100644 index 00000000..7cbcd69d --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/CommitInfo_html.html @@ -0,0 +1,888 @@ + + + + + + +CommitInfo.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::CommitInfo
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::CommitInfo";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">CommitInfo</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::CommitInfo
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::CommitInfo</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/commit_info.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_from_options-class_method" title="build_from_options (class method)">.<strong>build_from_options</strong>(options)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build_from_options-class_method">
+
+  .<strong>build_from_options</strong>(options)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

11 12 13 14 15 16 17 18 19 20 21 22 23 24</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/commit_info.rb', line 11</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_build_from_options'>build_from_options</span><span +class='lparen'>(</span><span class='id identifier +rubyid_options'>options</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
+  <span class='kw'>case</span> <span class='id identifier rubyid_key'>key</span>
+  <span class='kw'>when</span> <span class='symbol'>:mode</span>
+    <span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='id identifier rubyid_build_write_mode'>build_write_mode</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='rbracket'>]</span>
+  <span class='kw'>when</span> <span class='symbol'>:client_modified</span>
+    <span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='id identifier rubyid_build_client_modified'>build_client_modified</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='rbracket'>]</span>
+  <span class='kw'>when</span> <span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:autorename</span><span class='comma'>,</span> <span class='symbol'>:mute</span>
+    <span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rbracket'>]</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span><span class='rbracket'>]</span>
+
+<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/Deleted_html.html b/doc/docs/DropboxApi/Metadata/Deleted_html.html new file mode 100644 index 00000000..f0501967 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/Deleted_html.html @@ -0,0 +1,841 @@ + + + + + + +Deleted.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::Deleted
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::Deleted";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">Deleted</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::Deleted
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::Deleted</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/deleted.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::Deleted (class)">Deleted</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;: &quot;deleted&quot;,
+&quot;name&quot;: &quot;file.txt&quot;,
+&quot;path_lower&quot;: &quot;/file.txt&quot;,
+&quot;path_display&quot;: &quot;/file.txt&quot;
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/Dimensions_html.html b/doc/docs/DropboxApi/Metadata/Dimensions_html.html new file mode 100644 index 00000000..6203d0a9 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/Dimensions_html.html @@ -0,0 +1,821 @@ + + + + + + +Dimensions.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::Dimensions
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::Dimensions";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">Dimensions</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::Dimensions
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::Dimensions</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/dimensions.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/Field_html.html b/doc/docs/DropboxApi/Metadata/Field_html.html new file mode 100644 index 00000000..68e09e09 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/Field_html.html @@ -0,0 +1,997 @@ + + + + + + +Field.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::Field
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::Field";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">Field</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::Field
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::Metadata::Field</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/field.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#cast-instance_method" title="#cast (instance method)">#<strong>cast</strong>(object)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#force_cast-instance_method" title="#force_cast (instance method)">#<strong>force_cast</strong>(object)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(type, options = [])  &#x21d2; Field </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of Field.</p>
+ +

</div></span>

+ +

</li>

+ +
</ul>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(type, options = [])  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Metadata::Field (class)">Field</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of Field.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/field.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_type'>type</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbracket'>[</span><span +class='rbracket'>]</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@type</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span>
+<span class='ivar'>@options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="cast-instance_method">
+
+  #<strong>cast</strong>(object)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

9 10 11 12 13 14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/field.rb', line 9</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_cast'>cast</span><span +class='lparen'>(</span><span class='id identifier +rubyid_object'>object</span><span +class='rparen'>)</span>

+ +
<span class='kw'>if</span> <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span> <span class='kw'>unless</span> <span class='ivar'>@options</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='symbol'>:optional</span>
+  <span class='kw'>nil</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_force_cast'>force_cast</span> <span class='id identifier rubyid_object'>object</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="force_cast-instance_method">
+
+  #<strong>force_cast</strong>(object)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/field.rb', line 18</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_force_cast'>force_cast</span><span +class='lparen'>(</span><span class='id identifier +rubyid_object'>object</span><span +class='rparen'>)</span>

+ +
<span class='kw'>if</span> <span class='ivar'>@type</span> <span class='op'>==</span> <span class='const'>String</span>
+  <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+<span class='kw'>elsif</span> <span class='ivar'>@type</span> <span class='op'>==</span> <span class='const'>Time</span>
+  <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
+<span class='kw'>elsif</span> <span class='ivar'>@type</span> <span class='op'>==</span> <span class='const'>Integer</span>
+  <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
+<span class='kw'>elsif</span> <span class='ivar'>@type</span> <span class='op'>==</span> <span class='const'>Float</span>
+  <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_to_f'>to_f</span>
+<span class='kw'>elsif</span> <span class='ivar'>@type</span> <span class='op'>==</span> <span class='const'>Symbol</span>
+  <span class='id identifier rubyid_object'>object</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
+<span class='kw'>elsif</span> <span class='ivar'>@type</span> <span class='op'>==</span> <span class='symbol'>:boolean</span>
+  <span class='id identifier rubyid_object'>object</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>true</span><span class='tstring_end'>&#39;</span></span>
+<span class='kw'>elsif</span> <span class='ivar'>@type</span><span class='period'>.</span><span class='id identifier rubyid_ancestors'>ancestors</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span><span class='rparen'>)</span> <span class='op'>||</span>
+      <span class='ivar'>@type</span><span class='period'>.</span><span class='id identifier rubyid_ancestors'>ancestors</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> <span class='op'>||</span>
+      <span class='ivar'>@type</span> <span class='op'>==</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span></span>
+  <span class='ivar'>@type</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_object'>object</span><span class='rparen'>)</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Can&#39;t cast </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_object'>object</span><span class='embexpr_end'>}</span><span class='tstring_content'> to `</span><span class='embexpr_beg'>#{</span><span class='ivar'>@type</span><span class='embexpr_end'>}</span><span class='tstring_content'>`</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/FileCategoriesList_html.html b/doc/docs/DropboxApi/Metadata/FileCategoriesList_html.html new file mode 100644 index 00000000..c8b7fbac --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/FileCategoriesList_html.html @@ -0,0 +1,878 @@ + + + + + + +FileCategoriesList.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::FileCategoriesList
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::FileCategoriesList";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">FileCategoriesList</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::FileCategoriesList
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Array</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">Array</li>
+
+          <li class="next">DropboxApi::Metadata::FileCategoriesList</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/file_categories_list.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(list)  &#x21d2; FileCategoriesList </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of FileCategoriesList.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(list)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Metadata::FileCategoriesList (class)">FileCategoriesList</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of FileCategoriesList.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

5 6 7</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/file_categories_list.rb', line 5</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_list'>list</span><span +class='rparen'>)</span>

+ +
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="FileCategory.html" title="DropboxApi::Metadata::FileCategory (class)">FileCategory</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Tag.html#new-class_method" title="DropboxApi::Metadata::Tag.new (method)">new</a></span></span> <span class='id identifier rubyid_c'>c</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/FileCategory_html.html b/doc/docs/DropboxApi/Metadata/FileCategory_html.html new file mode 100644 index 00000000..a2177105 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/FileCategory_html.html @@ -0,0 +1,909 @@ + + + + + + +FileCategory.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::FileCategory
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::FileCategory";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">FileCategory</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::FileCategory
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::FileCategory</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/file_category.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="VALID_VALUES-constant" class="">VALID_VALUES =
+
+      </dt>
+      <dd><pre class="code"><span class='qsymbols_beg'>%i[</span><span class='words_sep'>
+</span><span class='tstring_content'>image</span><span class='words_sep'>
+</span><span class='tstring_content'>document</span><span class='words_sep'>
+</span><span class='tstring_content'>pdf</span><span class='words_sep'>
+</span><span class='tstring_content'>spreadsheet</span><span class='words_sep'>
+</span><span class='tstring_content'>presentation</span><span class='words_sep'>
+</span><span class='tstring_content'>audio</span><span class='words_sep'>
+</span><span class='tstring_content'>video</span><span class='words_sep'>
+</span><span class='tstring_content'>folder</span><span class='words_sep'>
+</span><span class='tstring_content'>paper</span><span class='words_sep'>
+</span><span class='tstring_content'>others</span><span class='words_sep'>
+ +

</span><span +class='tstring_end'>]</span></span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#valid_values-class_method" title="valid_values (class method)">.<strong>valid_values</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Tag.html#new-class_method" title="DropboxApi::Metadata::Tag.new (method)">new</a></span>, <span class='object_link'><a href="Tag.html#validate-class_method" title="DropboxApi::Metadata::Tag.validate (method)">validate</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="valid_values-class_method">
+
+  .<strong>valid_values</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/file_category.rb', line 18</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_valid_values'>valid_values</span>

+ +
<span class='const'><span class='object_link'><a href="#VALID_VALUES-constant" title="DropboxApi::Metadata::FileCategory::VALID_VALUES (constant)">VALID_VALUES</a></span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/FileExtensionsList_html.html b/doc/docs/DropboxApi/Metadata/FileExtensionsList_html.html new file mode 100644 index 00000000..bb194417 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/FileExtensionsList_html.html @@ -0,0 +1,882 @@ + + + + + + +FileExtensionsList.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::FileExtensionsList
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::FileExtensionsList";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">FileExtensionsList</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::FileExtensionsList
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Array</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">Array</li>
+
+          <li class="next">DropboxApi::Metadata::FileExtensionsList</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/file_extensions_list.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(data)  &#x21d2; FileExtensionsList </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of FileExtensionsList.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(data)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Metadata::FileExtensionsList (class)">FileExtensionsList</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of FileExtensionsList.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

5 6 7 8 9 10 11</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/file_extensions_list.rb', line 5</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_data'>data</span><span +class='rparen'>)</span>

+ +
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='op'>!</span><span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>String</span> <span class='rbrace'>}</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid extension list: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+
+<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/FileLinkMetadata_html.html b/doc/docs/DropboxApi/Metadata/FileLinkMetadata_html.html new file mode 100644 index 00000000..7c79bfea --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/FileLinkMetadata_html.html @@ -0,0 +1,863 @@ + + + + + + +FileLinkMetadata.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::FileLinkMetadata
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::FileLinkMetadata";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">FileLinkMetadata</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::FileLinkMetadata
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::FileLinkMetadata</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/file_link_metadata.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::FileLinkMetadata (class)">FileLinkMetadata</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;: &quot;file&quot;,
+&quot;url&quot;: &quot;https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0&quot;,
+&quot;name&quot;: &quot;Prime_Numbers.txt&quot;,
+&quot;link_permissions&quot;: {
+  &quot;can_revoke&quot;: false,
+  &quot;resolved_visibility&quot;: {
+    &quot;.tag&quot;: &quot;public&quot;
+  },
+  &quot;revoke_failure_reason&quot;: {
+    &quot;.tag&quot;: &quot;owner_only&quot;
+  }
+},
+&quot;client_modified&quot;: &quot;2015-05-12T15:50:38Z&quot;,
+&quot;server_modified&quot;: &quot;2015-05-12T15:50:38Z&quot;,
+&quot;rev&quot;: &quot;a1c10ce0dd78&quot;,
+&quot;size&quot;: 7212,
+&quot;id&quot;: &quot;id:a4ayc_80_OEAAAAAAAAAXw&quot;,
+&quot;path_lower&quot;: &quot;/homework/math/prime_numbers.txt&quot;,
+&quot;team_member_info&quot;: {
+  &quot;team_info&quot;: {
+    &quot;id&quot;: &quot;dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I&quot;,
+    &quot;name&quot;: &quot;Acme, Inc.&quot;
+  },
+  &quot;display_name&quot;: &quot;Roger Rabbit&quot;,
+  &quot;member_id&quot;: &quot;dbmid:abcd1234&quot;
+}
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/FileMemberAction_html.html b/doc/docs/DropboxApi/Metadata/FileMemberAction_html.html new file mode 100644 index 00000000..9682f999 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/FileMemberAction_html.html @@ -0,0 +1,897 @@ + + + + + + +FileMemberAction.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::FileMemberAction
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::FileMemberAction";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">FileMemberAction</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::FileMemberAction
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::FileMemberAction</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/file_member_action.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized FileMemberAction:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;: &quot;success&quot;,
+&quot;success&quot;: {
+  &quot;.tag&quot;: &quot;viewer&quot;
+}
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

15 16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/file_member_action.rb', line 15</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_data'>data</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_tag'>tag</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='id identifier rubyid_class_for'>class_for</span><span class='lparen'>(</span><span class='id identifier rubyid_tag'>tag</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='id identifier rubyid_tag'>tag</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/FileRequest_html.html b/doc/docs/DropboxApi/Metadata/FileRequest_html.html new file mode 100644 index 00000000..fba15bbb --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/FileRequest_html.html @@ -0,0 +1,850 @@ + + + + + + +FileRequest.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::FileRequest
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::FileRequest";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">FileRequest</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::FileRequest
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::FileRequest</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/file_request.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::FileRequest (class)">FileRequest</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;id&quot;: &quot;oaCAVmEyrqYnkZX9955Y&quot;,
+&quot;url&quot;: &quot;https://www.dropbox.com/request/oaCAVmEyrqYnkZX9955Y&quot;,
+&quot;title&quot;: &quot;Homework submission&quot;,
+&quot;created&quot;: &quot;2015-10-05T17:00:00Z&quot;,
+&quot;is_open&quot;: true,
+&quot;file_count&quot;: 3,
+&quot;destination&quot;: &quot;/File Requests/Homework&quot;,
+&quot;deadline&quot;: {
+    &quot;deadline&quot;: &quot;2020-10-12T17:00:00Z&quot;,
+    &quot;allow_late_uploads&quot;: {
+        &quot;.tag&quot;: &quot;seven_days&quot;
+    }
+}
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/FileStatus_html.html b/doc/docs/DropboxApi/Metadata/FileStatus_html.html new file mode 100644 index 00000000..3c10b303 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/FileStatus_html.html @@ -0,0 +1,901 @@ + + + + + + +FileStatus.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::FileStatus
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::FileStatus";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">FileStatus</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::FileStatus
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::FileStatus</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/file_status.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="VALID_VALUES-constant" class="">VALID_VALUES =
+
+      </dt>
+      <dd><pre class="code"><span class='qsymbols_beg'>%i[</span><span class='words_sep'>
+</span><span class='tstring_content'>active</span><span class='words_sep'>
+</span><span class='tstring_content'>deleted</span><span class='words_sep'>
+ +

</span><span +class='tstring_end'>]</span></span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#valid_values-class_method" title="valid_values (class method)">.<strong>valid_values</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Tag.html#new-class_method" title="DropboxApi::Metadata::Tag.new (method)">new</a></span>, <span class='object_link'><a href="Tag.html#validate-class_method" title="DropboxApi::Metadata::Tag.validate (method)">validate</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="valid_values-class_method">
+
+  .<strong>valid_values</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

10 11 12</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/file_status.rb', line 10</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_valid_values'>valid_values</span>

+ +
<span class='const'><span class='object_link'><a href="#VALID_VALUES-constant" title="DropboxApi::Metadata::FileStatus::VALID_VALUES (constant)">VALID_VALUES</a></span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/File_html.html b/doc/docs/DropboxApi/Metadata/File_html.html new file mode 100644 index 00000000..c1a13067 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/File_html.html @@ -0,0 +1,903 @@ + + + + + + +File.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::File
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::File";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">File</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::File
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::File</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/file.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::File (class)">File</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;: &quot;file&quot;,
+&quot;name&quot;: &quot;Prime_Numbers.txt&quot;,
+&quot;path_lower&quot;: &quot;/homework/math/prime_numbers.txt&quot;,
+&quot;path_display&quot;: &quot;/Homework/math/Prime_Numbers.txt&quot;,
+&quot;id&quot;: &quot;id:a4ayc_80_OEAAAAAAAAAXw&quot;,
+&quot;client_modified&quot;: &quot;2015-05-12T15:50:38Z&quot;,
+&quot;server_modified&quot;: &quot;2015-05-12T15:50:38Z&quot;,
+&quot;rev&quot;: &quot;a1c10ce0dd78&quot;,
+&quot;size&quot;: 7212,
+&quot;sharing_info&quot;: {
+  &quot;read_only&quot;: true,
+  &quot;parent_shared_folder_id&quot;: &quot;84528192421&quot;,
+  &quot;modified_by&quot;: &quot;dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc&quot;
+}
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#to_hash-instance_method" title="#to_hash (instance method)">#<strong>to_hash</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="to_hash-instance_method">
+
+  #<strong>to_hash</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

36 37 38</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/file.rb', line 36</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_to_hash'>to_hash</span>

+ +
<span class='kw'>super</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>file</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/FolderLinkMetadata_html.html b/doc/docs/DropboxApi/Metadata/FolderLinkMetadata_html.html new file mode 100644 index 00000000..4a5ceb7f --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/FolderLinkMetadata_html.html @@ -0,0 +1,821 @@ + + + + + + +FolderLinkMetadata.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::FolderLinkMetadata
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::FolderLinkMetadata";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">FolderLinkMetadata</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::FolderLinkMetadata
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::FolderLinkMetadata</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/folder_link_metadata.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/FolderSharingInfo_html.html b/doc/docs/DropboxApi/Metadata/FolderSharingInfo_html.html new file mode 100644 index 00000000..c4da4ae1 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/FolderSharingInfo_html.html @@ -0,0 +1,839 @@ + + + + + + +FolderSharingInfo.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::FolderSharingInfo
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::FolderSharingInfo";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">FolderSharingInfo</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::FolderSharingInfo
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::FolderSharingInfo</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/folder_sharing_info.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::FolderSharingInfo (class)">FolderSharingInfo</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;read_only&quot;: false,
+&quot;parent_shared_folder_id&quot;: &quot;84528192421&quot;
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/Folder_html.html b/doc/docs/DropboxApi/Metadata/Folder_html.html new file mode 100644 index 00000000..be0a8e78 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/Folder_html.html @@ -0,0 +1,893 @@ + + + + + + +Folder.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::Folder
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::Folder";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (F)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">Folder</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::Folder
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::Folder</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/folder.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::Folder (class)">Folder</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;name&quot;: &quot;arizona_baby&quot;,
+&quot;path_lower&quot;: &quot;/arizona_baby&quot;,
+&quot;path_display&quot;: &quot;/arizona_baby&quot;,
+&quot;id&quot;: &quot;id:7eWkV5hcfzAAAAAAAAAAAQ&quot;
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#to_hash-instance_method" title="#to_hash (instance method)">#<strong>to_hash</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="to_hash-instance_method">
+
+  #<strong>to_hash</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

20 21 22</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/folder.rb', line 20</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_to_hash'>to_hash</span>

+ +
<span class='kw'>super</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>folder</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/LinkPermissions_html.html b/doc/docs/DropboxApi/Metadata/LinkPermissions_html.html new file mode 100644 index 00000000..0f8d7861 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/LinkPermissions_html.html @@ -0,0 +1,844 @@ + + + + + + +LinkPermissions.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::LinkPermissions
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::LinkPermissions";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">LinkPermissions</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::LinkPermissions
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::LinkPermissions</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/link_permissions.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::LinkPermissions (class)">LinkPermissions</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;can_revoke&quot;: false,
+&quot;resolved_visibility&quot;: {
+  &quot;.tag&quot;: &quot;public&quot;
+},
+&quot;revoke_failure_reason&quot;: {
+  &quot;.tag&quot;: &quot;owner_only&quot;
+}
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/Location_html.html b/doc/docs/DropboxApi/Metadata/Location_html.html new file mode 100644 index 00000000..66edc396 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/Location_html.html @@ -0,0 +1,821 @@ + + + + + + +Location.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::Location
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::Location";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">Location</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::Location
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::Location</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/location.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/MediaInfo_html.html b/doc/docs/DropboxApi/Metadata/MediaInfo_html.html new file mode 100644 index 00000000..a8d9de9c --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/MediaInfo_html.html @@ -0,0 +1,908 @@ + + + + + + +MediaInfo.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::MediaInfo
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::MediaInfo";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">MediaInfo</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::MediaInfo
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::MediaInfo</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/media_info.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::MediaInfo (class)">MediaInfo</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;: &quot;metadata&quot;,
+&quot;metadata&quot;: {...}
+ +

} </code></pre>

+ +

<p>or:</p>

+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;: &quot;pending&quot;
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

21 22 23 24 25 26 27 28 29</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/media_info.rb', line 21</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_data'>data</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_klass'>klass</span> <span class='op'>=</span> <span class='id identifier rubyid_class_for'>class_for</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span>
+
+<span class='kw'>if</span> <span class='id identifier rubyid_klass'>klass</span> <span class='op'>==</span> <span class='symbol'>:pending</span>
+  <span class='symbol'>:pending</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_klass'>klass</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>metadata</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/MediaMetadata_html.html b/doc/docs/DropboxApi/Metadata/MediaMetadata_html.html new file mode 100644 index 00000000..8f70ec94 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/MediaMetadata_html.html @@ -0,0 +1,904 @@ + + + + + + +MediaMetadata.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::MediaMetadata
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::MediaMetadata";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">MediaMetadata</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::MediaMetadata
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::MediaMetadata</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/media_metadata.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="MediaInfo.html" title="DropboxApi::Metadata::MediaInfo (class)">MediaInfo</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;: &quot;video&quot;,
+&quot;dimensions&quot;: {
+  &quot;height&quot;: 1500,
+  &quot;width&quot;: 1500
+},
+&quot;location&quot;: {
+  &quot;latitude&quot;: 10.123456,
+  &quot;longitude&quot;: 5.123456
+}
+&quot;time_taken&quot;: &quot;2016-09-04T17:00:27Z&quot;,
+&quot;duration&quot;: 6000
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

22 23 24 25</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/media_metadata.rb', line 22</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_data'>data</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_tag'>tag</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='id identifier rubyid_class_for'>class_for</span><span class='lparen'>(</span><span class='id identifier rubyid_tag'>tag</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/MemberActionList_html.html b/doc/docs/DropboxApi/Metadata/MemberActionList_html.html new file mode 100644 index 00000000..92eb7bdd --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/MemberActionList_html.html @@ -0,0 +1,895 @@ + + + + + + +MemberActionList.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::MemberActionList
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::MemberActionList";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">MemberActionList</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::MemberActionList
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Array</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">Array</li>
+
+          <li class="next">DropboxApi::Metadata::MemberActionList</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/member_action_list.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(list)  &#x21d2; MemberActionList </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>Builds a list of actions for a shared folder.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(list)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Metadata::MemberActionList (class)">MemberActionList</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Builds a list of actions for a shared folder.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+    <pre class="example code"><code><span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Metadata::MemberActionList (class)">MemberActionList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:leave_a_copy</span><span class='comma'>,</span> <span class='symbol'>:make_editor</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+ +

<span class='comment'># =&gt; [:leave_a_copy, +:make_editor]</span></code></pre>

+ +
</div>
+
+<p class="tag_title">See Also:</p>
+<ul class="see">
+
+    <li><span class='object_link'><a href="MemberAction.html" title="DropboxApi::Metadata::MemberAction (class)">DropboxApi::Metadata::MemberAction</a></span></li>
+
+</ul>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

10 11 12</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/member_action_list.rb', line 10</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_list'>list</span><span +class='rparen'>)</span>

+ +
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="MemberAction.html" title="DropboxApi::Metadata::MemberAction (class)">MemberAction</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Tag.html#new-class_method" title="DropboxApi::Metadata::Tag.new (method)">new</a></span></span> <span class='id identifier rubyid_a'>a</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/MemberAction_html.html b/doc/docs/DropboxApi/Metadata/MemberAction_html.html new file mode 100644 index 00000000..4d46404f --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/MemberAction_html.html @@ -0,0 +1,935 @@ + + + + + + +MemberAction.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::MemberAction
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::MemberAction";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">MemberAction</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::MemberAction
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::MemberAction</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/member_action.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>An action will be one of the following:</p>
+ +

<ul> <li>:leave_a_copy: Allow the member to keep a +copy of the folder when removing.</li> +<li>:make_editor: Make the member an editor of the +folder.</li> <li>:make_owner: Make the member an +owner of the folder.</li> <li>:make_viewer: Make +the member a viewer of the folder.</li> +<li>:make_viewer_no_comment: Make the member a viewer of +the folder without commenting permissions.</li> +<li>:remove: Remove the member from the +folder.</li> </ul>

+ +

<p>Example of a serialized <span +class='object_link'><a href=“” +title=“DropboxApi::Metadata::MemberAction +(class)”>MemberAction</a></span> object:</p>

+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;: &quot;leave_a_copy&quot;
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="VALID_MEMBER_ACTIONS-constant" class="">VALID_MEMBER_ACTIONS =
+
+      </dt>
+      <dd><pre class="code"><span class='lbracket'>[</span>
+<span class='symbol'>:leave_a_copy</span><span class='comma'>,</span>
+<span class='symbol'>:make_editor</span><span class='comma'>,</span>
+<span class='symbol'>:make_owner</span><span class='comma'>,</span>
+<span class='symbol'>:make_viewer</span><span class='comma'>,</span>
+<span class='symbol'>:make_viewer_no_comment</span><span class='comma'>,</span>
+<span class='symbol'>:remove</span>
+ +

<span class='rbracket'>]</span></pre></dd>

+ +
  </dl>
+
+  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#valid_values-class_method" title="valid_values (class method)">.<strong>valid_values</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Tag.html#new-class_method" title="DropboxApi::Metadata::Tag.new (method)">new</a></span>, <span class='object_link'><a href="Tag.html#validate-class_method" title="DropboxApi::Metadata::Tag.validate (method)">validate</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="valid_values-class_method">
+
+  .<strong>valid_values</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

31 32 33</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/member_action.rb', line 31</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_valid_values'>valid_values</span>

+ +
<span class='const'><span class='object_link'><a href="#VALID_MEMBER_ACTIONS-constant" title="DropboxApi::Metadata::MemberAction::VALID_MEMBER_ACTIONS (constant)">VALID_MEMBER_ACTIONS</a></span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/MemberPermissionList_html.html b/doc/docs/DropboxApi/Metadata/MemberPermissionList_html.html new file mode 100644 index 00000000..ba5848ec --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/MemberPermissionList_html.html @@ -0,0 +1,918 @@ + + + + + + +MemberPermissionList.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::MemberPermissionList
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::MemberPermissionList";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">MemberPermissionList</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::MemberPermissionList
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Array</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">Array</li>
+
+          <li class="next">DropboxApi::Metadata::MemberPermissionList</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/member_permission_list.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>This represents a collection of permissions on allowed on a
+ +

shared file or folder.</p>

+ +

<p>This is an example of a serialized <span +class='object_link'><a href=“MemberActionList.html” +title=“DropboxApi::Metadata::MemberActionList +(class)”>MemberActionList</a></span>:</p>

+ +

<pre class=“code json”><code class=“json”>[{

+ +
&quot;action&quot;: {
+  &quot;.tag&quot;: &quot;remove&quot;
+},
+&quot;allow&quot;: false,
+&quot;reason&quot;: {
+  &quot;.tag&quot;: &quot;target_is_self&quot;
+}
+ +

}, {

+ +
&quot;action&quot;: {
+  &quot;.tag&quot;: &quot;make_owner&quot;
+},
+&quot;allow&quot;: false,
+&quot;reason&quot;: {
+  &quot;.tag&quot;: &quot;target_is_self&quot;
+}
+ +

}] </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(list)  &#x21d2; MemberPermissionList </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of MemberPermissionList.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(list)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Metadata::MemberPermissionList (class)">MemberPermissionList</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of MemberPermissionList.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

27 28 29</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/member_permission_list.rb', line 27</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_list'>list</span><span +class='rparen'>)</span>

+ +
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="MemberPermission.html" title="DropboxApi::Metadata::MemberPermission (class)">MemberPermission</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span> <span class='id identifier rubyid_i'>i</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/MemberPermission_html.html b/doc/docs/DropboxApi/Metadata/MemberPermission_html.html new file mode 100644 index 00000000..0461dbf3 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/MemberPermission_html.html @@ -0,0 +1,849 @@ + + + + + + +MemberPermission.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::MemberPermission
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::MemberPermission";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">MemberPermission</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::MemberPermission
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::MemberPermission</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/member_permission.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>This is an example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::MemberPermission (class)">MemberPermission</a></span>:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;action&quot;: {
+  &quot;.tag&quot;: &quot;remove&quot;
+},
+&quot;allow&quot;: false,
+&quot;reason&quot;: {
+  &quot;.tag&quot;: &quot;target_is_self&quot;
+}
+ +

} </code></pre>

+ +

<p>This is normally contained in a <span +class='object_link'><a href=“MemberPermissionList.html” +title=“DropboxApi::Metadata::MemberPermissionList +(class)”>MemberPermissionList</a></span> object.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/Member_html.html b/doc/docs/DropboxApi/Metadata/Member_html.html new file mode 100644 index 00000000..255fd30a --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/Member_html.html @@ -0,0 +1,959 @@ + + + + + + +Member.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::Member
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::Member";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">Member</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::Member
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::Member</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/member.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Examples of serialized <span class='object_link'><a href="AddMember.html" title="DropboxApi::Metadata::AddMember (class)">AddMember</a></span> objects:</p>
+ +

<pre class=“code json”><code class=“json”>[

+ +
{
+  &quot;.tag&quot;: &quot;email&quot;,
+  &quot;email&quot;: &quot;justin@example.com&quot;
+},  {
+  &quot;.tag&quot;: &quot;dropbox_id&quot;,
+  &quot;dropbox_id&quot;: &quot;dbid:AAEufNrMPSPe0dMQijRP0N_aZtBJRm26W4Q&quot;
+}
+ +

] </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(member)  &#x21d2; Member </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of Member.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#to_hash-instance_method" title="#to_hash (instance method)">#<strong>to_hash</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(member)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Metadata::Member (class)">Member</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of Member.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

17 18 19 20 21 22 23 24 25 26 27 28</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/member.rb', line 17</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_member'>member</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@member_hash</span> <span class='op'>=</span> <span class='kw'>case</span> <span class='id identifier rubyid_member'>member</span>
+  <span class='kw'>when</span> <span class='const'>Hash</span>
+    <span class='id identifier rubyid_member'>member</span>
+  <span class='kw'>when</span> <span class='const'>String</span>
+    <span class='id identifier rubyid_hash_from_email_or_dropbox_id'>hash_from_email_or_dropbox_id</span> <span class='id identifier rubyid_member'>member</span>
+  <span class='kw'>when</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Metadata::Member (class)">Member</a></span></span>
+    <span class='id identifier rubyid_member'>member</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'>to_hash</span>
+  <span class='kw'>else</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid object for Member: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_member'>member</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="to_hash-instance_method">
+
+  #<strong>to_hash</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

30 31 32</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/member.rb', line 30</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_to_hash'>to_hash</span>

+ +
<span class='ivar'>@member_hash</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/MetadataV2_html.html b/doc/docs/DropboxApi/Metadata/MetadataV2_html.html new file mode 100644 index 00000000..cc97e26f --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/MetadataV2_html.html @@ -0,0 +1,821 @@ + + + + + + +MetadataV2.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::MetadataV2
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::MetadataV2";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">MetadataV2</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::MetadataV2
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::MetadataV2</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/metadata_v2.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/Name_html.html b/doc/docs/DropboxApi/Metadata/Name_html.html new file mode 100644 index 00000000..6fdda442 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/Name_html.html @@ -0,0 +1,841 @@ + + + + + + +Name.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::Name
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::Name";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (N)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">Name</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::Name
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::Name</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/name.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::Name (class)">Name</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;given_name&quot;: &quot;Franz&quot;,
+&quot;surname&quot;: &quot;Ferdinand&quot;,
+&quot;familiar_name&quot;: &quot;Franz&quot;,
+&quot;display_name&quot;: &quot;Franz Ferdinand (Personal)&quot;
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/NamespaceId_html.html b/doc/docs/DropboxApi/Metadata/NamespaceId_html.html new file mode 100644 index 00000000..c4577525 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/NamespaceId_html.html @@ -0,0 +1,873 @@ + + + + + + +NamespaceId.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::NamespaceId
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::NamespaceId";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (N)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">NamespaceId</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::NamespaceId
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::NamespaceId</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/namespace_id.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#to_hash-instance_method" title="#to_hash (instance method)">#<strong>to_hash</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="to_hash-instance_method">
+
+  #<strong>to_hash</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

6 7 8</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/namespace_id.rb', line 6</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_to_hash'>to_hash</span>

+ +
<span class='kw'>super</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.tag</span><span class='label_end'>&quot;:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>namespace_id</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/ParentFolderAccessInfo_html.html b/doc/docs/DropboxApi/Metadata/ParentFolderAccessInfo_html.html new file mode 100644 index 00000000..661e3062 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/ParentFolderAccessInfo_html.html @@ -0,0 +1,821 @@ + + + + + + +ParentFolderAccessInfo.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::ParentFolderAccessInfo
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::ParentFolderAccessInfo";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (P)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">ParentFolderAccessInfo</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::ParentFolderAccessInfo
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::ParentFolderAccessInfo</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/parent_folder_access_info.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/PhotoMetadata_html.html b/doc/docs/DropboxApi/Metadata/PhotoMetadata_html.html new file mode 100644 index 00000000..90d465e0 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/PhotoMetadata_html.html @@ -0,0 +1,847 @@ + + + + + + +PhotoMetadata.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::PhotoMetadata
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::PhotoMetadata";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (P)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">PhotoMetadata</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::PhotoMetadata
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::PhotoMetadata</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/photo_metadata.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::PhotoMetadata (class)">PhotoMetadata</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;: &quot;photo&quot;,
+&quot;dimensions&quot;: {
+  &quot;height&quot;: 1500,
+  &quot;width&quot;: 1500
+},
+&quot;location&quot;: {
+  &quot;latitude&quot;: 10.123456,
+  &quot;longitude&quot;: 5.123456
+}
+&quot;time_taken&quot;: &quot;2016-09-04T17:00:27Z&quot;
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/Resource_html.html b/doc/docs/DropboxApi/Metadata/Resource_html.html new file mode 100644 index 00000000..10fc6bbc --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/Resource_html.html @@ -0,0 +1,883 @@ + + + + + + +Resource.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::Resource
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::Resource";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">Resource</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::Resource
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::Metadata::Resource</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/resource.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>This class is used as an adapter so we can create an object of the pertinent
+ +

class when we need to infer the type from the data.</p>

+ +

<p>For example, calling Resource.new({&quot;.tag&quot; +=&gt; &quot;file&quot;, :name =&gt; ...}) will +instantiate a File object.</p>

+ +

<p>So this could initalize an object of either File, +Folder or Deleted.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/resource.rb', line 12</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_data'>data</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_class_for'>class_for</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/RootInfo_html.html b/doc/docs/DropboxApi/Metadata/RootInfo_html.html new file mode 100644 index 00000000..86286c3a --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/RootInfo_html.html @@ -0,0 +1,895 @@ + + + + + + +RootInfo.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::RootInfo
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::RootInfo";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">RootInfo</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::RootInfo
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::RootInfo</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/root_info.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::RootInfo (class)">RootInfo</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;:&quot;user&quot;,
+&quot;root_namespace_id&quot;:&quot;42&quot;,
+&quot;home_namespace_id&quot;:&quot;42&quot;
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/root_info.rb', line 14</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_data'>data</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_class_for'>class_for</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/SearchMatchFieldOptions_html.html b/doc/docs/DropboxApi/Metadata/SearchMatchFieldOptions_html.html new file mode 100644 index 00000000..19f9a7b2 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/SearchMatchFieldOptions_html.html @@ -0,0 +1,821 @@ + + + + + + +SearchMatchFieldOptions.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::SearchMatchFieldOptions
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::SearchMatchFieldOptions";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">SearchMatchFieldOptions</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::SearchMatchFieldOptions
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::SearchMatchFieldOptions</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/search_match_field_options.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/SearchMatchTypeV2_html.html b/doc/docs/DropboxApi/Metadata/SearchMatchTypeV2_html.html new file mode 100644 index 00000000..47ad65ae --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/SearchMatchTypeV2_html.html @@ -0,0 +1,903 @@ + + + + + + +SearchMatchTypeV2.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::SearchMatchTypeV2
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::SearchMatchTypeV2";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">SearchMatchTypeV2</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::SearchMatchTypeV2
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::SearchMatchTypeV2</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/search_match_type_v2.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="VALID_VALUES-constant" class="">VALID_VALUES =
+
+      </dt>
+      <dd><pre class="code"><span class='qsymbols_beg'>%i[</span><span class='words_sep'>
+</span><span class='tstring_content'>filename</span><span class='words_sep'>
+</span><span class='tstring_content'>file_content</span><span class='words_sep'>
+</span><span class='tstring_content'>filename_and_content</span><span class='words_sep'>
+</span><span class='tstring_content'>image_content</span><span class='words_sep'>
+ +

</span><span +class='tstring_end'>]</span></span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#valid_values-class_method" title="valid_values (class method)">.<strong>valid_values</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Tag.html#new-class_method" title="DropboxApi::Metadata::Tag.new (method)">new</a></span>, <span class='object_link'><a href="Tag.html#validate-class_method" title="DropboxApi::Metadata::Tag.validate (method)">validate</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="valid_values-class_method">
+
+  .<strong>valid_values</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/search_match_type_v2.rb', line 12</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_valid_values'>valid_values</span>

+ +
<span class='const'><span class='object_link'><a href="#VALID_VALUES-constant" title="DropboxApi::Metadata::SearchMatchTypeV2::VALID_VALUES (constant)">VALID_VALUES</a></span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/SearchMatchV2_html.html b/doc/docs/DropboxApi/Metadata/SearchMatchV2_html.html new file mode 100644 index 00000000..d566993f --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/SearchMatchV2_html.html @@ -0,0 +1,880 @@ + + + + + + +SearchMatchV2.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::SearchMatchV2
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::SearchMatchV2";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">SearchMatchV2</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::SearchMatchV2
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::SearchMatchV2</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/search_match_v2.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#resource-instance_method" title="#resource (instance method)">#<strong>resource</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="resource-instance_method">
+
+  #<strong>resource</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

11 12 13 14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/search_match_v2.rb', line 11</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_resource'>resource</span>

+ +
<span class='comment'># for some strange reason, v2 of this search endpoint doesn&#39;t have
+ +

</span> <span class='comment'># the `resource` field +anymore and file metadata is wrapped in a </span> <span +class='comment'># metadata/metadata field… </span> +<span class='id identifier +rubyid_metadata'>metadata</span><span +class='period'>.</span><span class='id identifier +rubyid_metadata'>metadata</span> <span +class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/SearchOptions_html.html b/doc/docs/DropboxApi/Metadata/SearchOptions_html.html new file mode 100644 index 00000000..84c97942 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/SearchOptions_html.html @@ -0,0 +1,821 @@ + + + + + + +SearchOptions.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::SearchOptions
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::SearchOptions";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">SearchOptions</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::SearchOptions
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::SearchOptions</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/search_options.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/SearchOrderBy_html.html b/doc/docs/DropboxApi/Metadata/SearchOrderBy_html.html new file mode 100644 index 00000000..164a96e9 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/SearchOrderBy_html.html @@ -0,0 +1,901 @@ + + + + + + +SearchOrderBy.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::SearchOrderBy
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::SearchOrderBy";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">SearchOrderBy</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::SearchOrderBy
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next"><span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::SearchOrderBy</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/search_order_by.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="VALID_VALUES-constant" class="">VALID_VALUES =
+
+      </dt>
+      <dd><pre class="code"><span class='qsymbols_beg'>%i[</span><span class='words_sep'>
+</span><span class='tstring_content'>relevance</span><span class='words_sep'>
+</span><span class='tstring_content'>last_modified_time</span><span class='words_sep'>
+ +

</span><span +class='tstring_end'>]</span></span><span +class='period'>.</span><span class='id identifier +rubyid_freeze'>freeze</span></pre></dd>

+ +
  </dl>
+
+  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#valid_values-class_method" title="valid_values (class method)">.<strong>valid_values</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Tag.html#new-class_method" title="DropboxApi::Metadata::Tag.new (method)">new</a></span>, <span class='object_link'><a href="Tag.html#validate-class_method" title="DropboxApi::Metadata::Tag.validate (method)">validate</a></span></p>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="valid_values-class_method">
+
+  .<strong>valid_values</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

10 11 12</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/search_order_by.rb', line 10</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_valid_values'>valid_values</span>

+ +
<span class='const'><span class='object_link'><a href="#VALID_VALUES-constant" title="DropboxApi::Metadata::SearchOrderBy::VALID_VALUES (constant)">VALID_VALUES</a></span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/SharedFolderPolicy_html.html b/doc/docs/DropboxApi/Metadata/SharedFolderPolicy_html.html new file mode 100644 index 00000000..b8254574 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/SharedFolderPolicy_html.html @@ -0,0 +1,839 @@ + + + + + + +SharedFolderPolicy.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::SharedFolderPolicy
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::SharedFolderPolicy";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">SharedFolderPolicy</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::SharedFolderPolicy
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::SharedFolderPolicy</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/shared_folder_policy.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::SharedFolderPolicy (class)">SharedFolderPolicy</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;acl_update_policy&quot; =&gt; { &quot;.tag&quot; =&gt; &quot;owner&quot; },
+&quot;shared_link_policy&quot; =&gt; { &quot;.tag&quot; =&gt; &quot;anyone&quot; }
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/SharedFolder_html.html b/doc/docs/DropboxApi/Metadata/SharedFolder_html.html new file mode 100644 index 00000000..69289311 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/SharedFolder_html.html @@ -0,0 +1,848 @@ + + + + + + +SharedFolder.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::SharedFolder
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::SharedFolder";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">SharedFolder</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::SharedFolder
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::SharedFolder</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/shared_folder.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::SharedFolder (class)">SharedFolder</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot; =&gt; &quot;complete&quot;,
+&quot;access_type&quot; =&gt; {&quot;.tag&quot;=&gt;&quot;owner&quot;},
+&quot;is_team_folder&quot; =&gt; false,
+&quot;policy&quot; =&gt; {
+  &quot;acl_update_policy&quot; =&gt; { &quot;.tag&quot; =&gt; &quot;owner&quot; },
+  &quot;shared_link_policy&quot; =&gt; { &quot;.tag&quot; =&gt; &quot;anyone&quot; }
+},
+&quot;path_lower&quot; =&gt; &quot;/folder_a&quot;,
+&quot;name&quot; =&gt; &quot;folder_a&quot;,
+&quot;shared_folder_id&quot; =&gt; &quot;1231266557&quot;,
+&quot;time_invited&quot; =&gt; &quot;2016-06-04T10:00:35Z&quot;
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/SharedLinkMetadata_html.html b/doc/docs/DropboxApi/Metadata/SharedLinkMetadata_html.html new file mode 100644 index 00000000..2f602d6c --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/SharedLinkMetadata_html.html @@ -0,0 +1,879 @@ + + + + + + +SharedLinkMetadata.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::SharedLinkMetadata
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::SharedLinkMetadata";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">SharedLinkMetadata</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::SharedLinkMetadata
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::Metadata::SharedLinkMetadata</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/shared_link_metadata.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>This class is used as an adapter so we can create an object of the pertinent
+ +

class when we need to infer the type from the data.</p>

+ +

<p>This same pattern is used in +DropboxApi::Metadata::Resource</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

9 10 11</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/shared_link_metadata.rb', line 9</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_data'>data</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_class_for'>class_for</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/SharedLink_html.html b/doc/docs/DropboxApi/Metadata/SharedLink_html.html new file mode 100644 index 00000000..0d364080 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/SharedLink_html.html @@ -0,0 +1,997 @@ + + + + + + +SharedLink.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::SharedLink
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::SharedLink";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">SharedLink</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::SharedLink
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::SharedLink</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/shared_link.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="VALID_KEYS-constant" class="">VALID_KEYS =
+
+      </dt>
+      <dd><pre class="code"><span class='lbracket'>[</span><span class='symbol'>:url</span><span class='comma'>,</span> <span class='symbol'>:password</span><span class='rbracket'>]</span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#check_validity-instance_method" title="#check_validity (instance method)">#<strong>check_validity</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(param)  &#x21d2; SharedLink </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of SharedLink.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#to_hash-instance_method" title="#to_hash (instance method)">#<strong>to_hash</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(param)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Metadata::SharedLink (class)">SharedLink</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of SharedLink.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

6 7 8 9 10 11 12 13 14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/shared_link.rb', line 6</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_param'>param</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@shared_link</span> <span class='op'>=</span>
+  <span class='kw'>case</span> <span class='id identifier rubyid_param'>param</span>
+  <span class='kw'>when</span> <span class='const'>String</span>
+    <span class='lbrace'>{</span><span class='label'>url:</span> <span class='id identifier rubyid_param'>param</span><span class='rbrace'>}</span>
+  <span class='kw'>when</span> <span class='const'>Hash</span>
+    <span class='id identifier rubyid_param'>param</span>
+  <span class='kw'>end</span>
+
+<span class='id identifier rubyid_check_validity'>check_validity</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="check_validity-instance_method">
+
+  #<strong>check_validity</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

18 19 20 21 22 23 24 25 26 27 28</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/shared_link.rb', line 18</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_check_validity'>check_validity</span>

+ +
<span class='kw'>if</span> <span class='ivar'>@shared_link</span><span class='lbracket'>[</span><span class='symbol'>:url</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Missing `:url` option</span><span class='tstring_end'>&#39;</span></span>
+<span class='kw'>end</span>
+
+<span class='ivar'>@shared_link</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span>
+  <span class='kw'>unless</span> <span class='const'><span class='object_link'><a href="#VALID_KEYS-constant" title="DropboxApi::Metadata::SharedLink::VALID_KEYS (constant)">VALID_KEYS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_key'>key</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid option `</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>`</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="to_hash-instance_method">
+
+  #<strong>to_hash</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

30 31 32</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/shared_link.rb', line 30</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_to_hash'>to_hash</span>

+ +
<span class='ivar'>@shared_link</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/SpaceAllocation_html.html b/doc/docs/DropboxApi/Metadata/SpaceAllocation_html.html new file mode 100644 index 00000000..d3efb864 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/SpaceAllocation_html.html @@ -0,0 +1,839 @@ + + + + + + +SpaceAllocation.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::SpaceAllocation
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::SpaceAllocation";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">SpaceAllocation</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::SpaceAllocation
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::SpaceAllocation</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/space_allocation.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::SpaceAllocation (class)">SpaceAllocation</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;: &quot;individual&quot;,
+&quot;allocated&quot;: 2147483648
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/SpaceUsage_html.html b/doc/docs/DropboxApi/Metadata/SpaceUsage_html.html new file mode 100644 index 00000000..888dc11e --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/SpaceUsage_html.html @@ -0,0 +1,842 @@ + + + + + + +SpaceUsage.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::SpaceUsage
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::SpaceUsage";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">SpaceUsage</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::SpaceUsage
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::SpaceUsage</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/space_usage.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::SpaceUsage (class)">SpaceUsage</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;used&quot;: 167685342,
+&quot;allocation&quot;: {
+  &quot;.tag&quot;: &quot;individual&quot;,
+  &quot;allocated&quot;: 2147483648
+}
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/Tag_html.html b/doc/docs/DropboxApi/Metadata/Tag_html.html new file mode 100644 index 00000000..d5021ee9 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/Tag_html.html @@ -0,0 +1,943 @@ + + + + + + +Tag.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::Tag
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::Tag";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">Tag</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::Tag
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::Tag</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/tag.rb</dd>
+</dl>
+ +

</div>

+ +

<div id=“subclasses”>

+ +
<h2>Direct Known Subclasses</h2>
+<p class="children"><span class='object_link'><a href="AccessLevel.html" title="DropboxApi::Metadata::AccessLevel (class)">AccessLevel</a></span>, <span class='object_link'><a href="FileCategory.html" title="DropboxApi::Metadata::FileCategory (class)">FileCategory</a></span>, <span class='object_link'><a href="FileStatus.html" title="DropboxApi::Metadata::FileStatus (class)">FileStatus</a></span>, <span class='object_link'><a href="MemberAction.html" title="DropboxApi::Metadata::MemberAction (class)">MemberAction</a></span>, <span class='object_link'><a href="SearchMatchTypeV2.html" title="DropboxApi::Metadata::SearchMatchTypeV2 (class)">SearchMatchTypeV2</a></span>, <span class='object_link'><a href="SearchOrderBy.html" title="DropboxApi::Metadata::SearchOrderBy (class)">SearchOrderBy</a></span></p>
+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#validate-class_method" title="validate (class method)">.<strong>validate</strong>(value)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8 9 10 11 12 13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/tag.rb', line 4</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_data'>data</span><span +class='rparen'>)</span>

+ +
<span class='kw'>case</span> <span class='id identifier rubyid_data'>data</span>
+<span class='kw'>when</span> <span class='op'>::</span><span class='const'>Symbol</span>
+  <span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+<span class='kw'>when</span> <span class='const'>Hash</span>
+  <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span>
+<span class='kw'>when</span> <span class='const'>String</span>
+  <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid object for </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="validate-class_method">
+
+  .<strong>validate</strong>(value)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

17 18 19 20 21 22 23</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/tag.rb', line 17</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_validate'>validate</span><span +class='lparen'>(</span><span class='id identifier +rubyid_value'>value</span><span +class='rparen'>)</span>

+ +
<span class='kw'>if</span> <span class='id identifier rubyid_valid_values'>valid_values</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_value'>value</span>
+  <span class='id identifier rubyid_value'>value</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid value for </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/TeamMemberInfo_html.html b/doc/docs/DropboxApi/Metadata/TeamMemberInfo_html.html new file mode 100644 index 00000000..5c03f3f1 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/TeamMemberInfo_html.html @@ -0,0 +1,843 @@ + + + + + + +TeamMemberInfo.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::TeamMemberInfo
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::TeamMemberInfo";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">TeamMemberInfo</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::TeamMemberInfo
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::TeamMemberInfo</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/team_member_info.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::TeamMemberInfo (class)">TeamMemberInfo</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;team_info&quot;: {
+  &quot;id&quot;: &quot;dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I&quot;,
+  &quot;name&quot;: &quot;Acme, Inc.&quot;
+},
+&quot;display_name&quot;: &quot;Roger Rabbit&quot;,
+&quot;member_id&quot;: &quot;dbmid:abcd1234&quot;
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/TeamRootInfo_html.html b/doc/docs/DropboxApi/Metadata/TeamRootInfo_html.html new file mode 100644 index 00000000..630f08d3 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/TeamRootInfo_html.html @@ -0,0 +1,821 @@ + + + + + + +TeamRootInfo.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::TeamRootInfo
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::TeamRootInfo";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">TeamRootInfo</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::TeamRootInfo
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::TeamRootInfo</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/team_root_info.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/Team_html.html b/doc/docs/DropboxApi/Metadata/Team_html.html new file mode 100644 index 00000000..b9b585e0 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/Team_html.html @@ -0,0 +1,821 @@ + + + + + + +Team.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::Team
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::Team";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">Team</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::Team
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::Team</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/team.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/ThumbnailBatchResultData_html.html b/doc/docs/DropboxApi/Metadata/ThumbnailBatchResultData_html.html new file mode 100644 index 00000000..032b5f0b --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/ThumbnailBatchResultData_html.html @@ -0,0 +1,821 @@ + + + + + + +ThumbnailBatchResultData.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::ThumbnailBatchResultData
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::ThumbnailBatchResultData";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">ThumbnailBatchResultData</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::ThumbnailBatchResultData
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::ThumbnailBatchResultData</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/thumbnail_batch_result_data.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry_html.html b/doc/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry_html.html new file mode 100644 index 00000000..57c880c2 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry_html.html @@ -0,0 +1,890 @@ + + + + + + +ThumbnailBatchResultEntry.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::ThumbnailBatchResultEntry
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::ThumbnailBatchResultEntry";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (T)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">ThumbnailBatchResultEntry</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::ThumbnailBatchResultEntry
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::Metadata::ThumbnailBatchResultEntry</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>This class is used as an adapter so we can create an object of the pertinent
+ +

class when we need to infer the type from the data.</p>

+ +

<p>This same pattern is used in +DropboxApi::Metadata::Resource</p>

+ +

<p>So this could initalize an object of either +ThumbnailBatchResultData or +ThumbnailError.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14 15 16 17 18 19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb', line 12</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_data'>data</span><span +class='rparen'>)</span>

+ +
<span class='kw'>case</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
+<span class='kw'>when</span> <span class='symbol'>:success</span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="ThumbnailBatchResultData.html" title="DropboxApi::Metadata::ThumbnailBatchResultData (class)">ThumbnailBatchResultData</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
+<span class='kw'>when</span> <span class='symbol'>:failure</span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Errors/ThumbnailError.html" title="DropboxApi::Errors::ThumbnailError (class)">ThumbnailError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_build'><span class='object_link'><a href="../Errors/BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Thumbnail generation failed</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>failure</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown result type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/UploadSessionCursor_html.html b/doc/docs/DropboxApi/Metadata/UploadSessionCursor_html.html new file mode 100644 index 00000000..db14f236 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/UploadSessionCursor_html.html @@ -0,0 +1,894 @@ + + + + + + +UploadSessionCursor.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::UploadSessionCursor
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::UploadSessionCursor";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">UploadSessionCursor</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::UploadSessionCursor
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::UploadSessionCursor</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/upload_session_cursor.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="" title="DropboxApi::Metadata::UploadSessionCursor (class)">UploadSessionCursor</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;session_id&quot;: &quot;AAAAAAAABCJ61k9yZZtn8Q&quot;,
+&quot;offset&quot;:9
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#offset=-instance_method" title="#offset= (instance method)">#<strong>offset=</strong>(n)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="offset=-instance_method">
+
+  #<strong>offset=</strong>(n)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/upload_session_cursor.rb', line 15</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_offset='>offset=</span><span +class='lparen'>(</span><span class='id identifier +rubyid_n'>n</span><span +class='rparen'>)</span>

+ +
<span class='kw'>self</span><span class='lbracket'>[</span><span class='symbol'>:offset</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_n'>n</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/UserRootInfo_html.html b/doc/docs/DropboxApi/Metadata/UserRootInfo_html.html new file mode 100644 index 00000000..ae1a9d0a --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/UserRootInfo_html.html @@ -0,0 +1,821 @@ + + + + + + +UserRootInfo.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::UserRootInfo
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::UserRootInfo";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">UserRootInfo</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::UserRootInfo
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::UserRootInfo</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/user_root_info.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/VideoMetadata_html.html b/doc/docs/DropboxApi/Metadata/VideoMetadata_html.html new file mode 100644 index 00000000..0916066a --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/VideoMetadata_html.html @@ -0,0 +1,848 @@ + + + + + + +VideoMetadata.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::VideoMetadata
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::VideoMetadata";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (V)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">VideoMetadata</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::VideoMetadata
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::VideoMetadata</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/video_metadata.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a serialized <span class='object_link'><a href="MediaInfo.html" title="DropboxApi::Metadata::MediaInfo (class)">MediaInfo</a></span> object:</p>
+ +

<pre class=“code json”><code class=“json”>{

+ +
&quot;.tag&quot;: &quot;video&quot;,
+&quot;dimensions&quot;: {
+  &quot;height&quot;: 1500,
+  &quot;width&quot;: 1500
+},
+&quot;location&quot;: {
+  &quot;latitude&quot;: 10.123456,
+  &quot;longitude&quot;: 5.123456
+}
+&quot;time_taken&quot;: &quot;2016-09-04T17:00:27Z&quot;,
+&quot;duration&quot;: 6000
+ +

} </code></pre>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>, <span class='object_link'><a href="Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">DropboxApi::Metadata::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata/WriteMode_html.html b/doc/docs/DropboxApi/Metadata/WriteMode_html.html new file mode 100644 index 00000000..24e6bf20 --- /dev/null +++ b/doc/docs/DropboxApi/Metadata/WriteMode_html.html @@ -0,0 +1,1065 @@ + + + + + + +WriteMode.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Metadata::WriteMode
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata::WriteMode";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (W)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span>
+   &raquo; 
+  <span class="title">WriteMode</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Metadata::WriteMode
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Metadata::WriteMode</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/write_mode.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Your intent when writing a file to some path. This is used to determine
+ +

what constitutes a conflict and what the autorename strategy is.</p>

+ +

<p>In some situations, the conflict behavior is identical:</p>

+ +

<ul> <li>If the target path doesn&#39;t contain anything, +the file is always written; no conflict.</li> <li>If the target +path contains a folder, it&#39;s always a conflict.</li> +<li>If the target path contains a file with identical contents, +nothing gets written; no conflict.</li> </ul>

+ +

<p>The conflict checking differs in the case where there&#39;s a +file at the target path with contents different from the contents +you&#39;re trying to write. The value will be one of the following +datatypes:</p>

+ +

<ul> <li>:add: Do not overwrite an existing file +if there is a conflict. The autorename strategy is to append a number to +the file name. For example, &quot;document.txt&quot; might become +&quot;document (2).txt&quot;.</li> +<li>:overwrite: Always overwrite the existing file. The +autorename strategy is the same as it is for add.</li> +<li>:update: Overwrite if the given +&quot;rev&quot; matches the existing file&#39;s +&quot;rev&quot;. The autorename strategy is to append the string +&quot;conflicted copy&quot; to the file name. For example, +&quot;document.txt&quot; might become &quot;document +(conflicted copy).txt&quot; or &quot;document (Panda&#39;s +conflicted copy).txt&quot;.</li> </ul>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="VALID_WRITE_MODES-constant" class="">VALID_WRITE_MODES =
+
+      </dt>
+      <dd><pre class="code"><span class='lbracket'>[</span>
+<span class='symbol'>:add</span><span class='comma'>,</span>
+<span class='symbol'>:overwrite</span><span class='comma'>,</span>
+<span class='symbol'>:update</span>
+ +

<span class='rbracket'>]</span></pre></dd>

+ +
  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#check_validity-instance_method" title="#check_validity (instance method)">#<strong>check_validity</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(write_mode, options = nil)  &#x21d2; WriteMode </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of WriteMode.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#to_hash-instance_method" title="#to_hash (instance method)">#<strong>to_hash</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>, <span class='object_link'><a href="Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(write_mode, options = nil)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Metadata::WriteMode (class)">WriteMode</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of WriteMode.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +
<div class="examples">
+  <p class="tag_title">Examples:</p>
+
+    <pre class="example code"><code><span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Metadata::WriteMode (class)">WriteMode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='symbol'>:add</span></code></pre>
+
+    <pre class="example code"><code><span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Metadata::WriteMode (class)">WriteMode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='symbol'>:overwrite</span></code></pre>
+
+    <pre class="example code"><code><span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Metadata::WriteMode (class)">WriteMode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='symbol'>:update</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>a1c10ce0dd78</span><span class='tstring_end'>&quot;</span></span></code></pre>
+
+    <pre class="example code"><code><span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="DropboxApi::Metadata::WriteMode (class)">WriteMode</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbrace'>{</span>
+<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&quot;</span></span><span class='op'>=&gt;</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>update</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>update</span><span class='tstring_end'>&quot;</span></span><span class='op'>=&gt;</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>a1c10ce0dd78</span><span class='tstring_end'>&quot;</span></span>
+ +

<span class='rbrace'>}</span><span +class='rparen'>)</span></code></pre>

+ +
</div>
+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

46 47 48 49 50 51 52 53 54 55 56 57 58 59</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/write_mode.rb', line 46</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_write_mode'>write_mode</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='kw'>nil</span><span +class='rparen'>)</span>

+ +
<span class='kw'>case</span> <span class='id identifier rubyid_write_mode'>write_mode</span>
+<span class='kw'>when</span> <span class='const'>Hash</span>
+  <span class='ivar'>@write_mode</span> <span class='op'>=</span> <span class='id identifier rubyid_write_mode'>write_mode</span>
+<span class='kw'>when</span> <span class='const'>String</span><span class='comma'>,</span> <span class='op'>::</span><span class='const'>Symbol</span>
+  <span class='ivar'>@write_mode</span> <span class='op'>=</span> <span class='lbrace'>{</span>
+    <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_write_mode'>write_mode</span>
+  <span class='rbrace'>}</span>
+  <span class='ivar'>@write_mode</span><span class='lbracket'>[</span><span class='id identifier rubyid_write_mode'>write_mode</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span> <span class='kw'>unless</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+<span class='kw'>end</span>
+<span class='ivar'>@write_mode</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@write_mode</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
+
+<span class='id identifier rubyid_check_validity'>check_validity</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="check_validity-instance_method">
+
+  #<strong>check_validity</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

61 62 63 64 65 66 67 68 69</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/write_mode.rb', line 61</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_check_validity'>check_validity</span>

+ +
<span class='kw'>unless</span> <span class='id identifier rubyid_valid_mode?'>valid_mode?</span> <span class='ivar'>@write_mode</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid write mode: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@write_mode</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+
+<span class='kw'>if</span> <span class='ivar'>@write_mode</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='symbol'>:update</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@write_mode</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>update</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Mode `:update` expects a `rev` number</span><span class='tstring_end'>&#39;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="to_hash-instance_method">
+
+  #<strong>to_hash</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

71 72 73</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/metadata/write_mode.rb', line 71</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_to_hash'>to_hash</span>

+ +
<span class='ivar'>@write_mode</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Metadata_html.html b/doc/docs/DropboxApi/Metadata_html.html new file mode 100644 index 00000000..73c10efb --- /dev/null +++ b/doc/docs/DropboxApi/Metadata_html.html @@ -0,0 +1,800 @@ + + + + + + +Metadata.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Module: DropboxApi::Metadata
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Metadata";
+relpath = '../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+   &raquo; 
+  <span class="title">Metadata</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Module: DropboxApi::Metadata
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/metadata/tag.rb<span class="defines">,<br />
+lib/dropbox_api/metadata/base.rb,<br /> lib/dropbox_api/metadata/file.rb,<br /> lib/dropbox_api/metadata/name.rb,<br /> lib/dropbox_api/metadata/team.rb,<br /> lib/dropbox_api/metadata/field.rb,<br /> lib/dropbox_api/metadata/folder.rb,<br /> lib/dropbox_api/metadata/member.rb,<br /> lib/dropbox_api/metadata/deleted.rb,<br /> lib/dropbox_api/metadata/location.rb,<br /> lib/dropbox_api/metadata/resource.rb,<br /> lib/dropbox_api/metadata/root_info.rb,<br /> lib/dropbox_api/metadata/add_member.rb,<br /> lib/dropbox_api/metadata/dimensions.rb,<br /> lib/dropbox_api/metadata/media_info.rb,<br /> lib/dropbox_api/metadata/write_mode.rb,<br /> lib/dropbox_api/metadata/commit_info.rb,<br /> lib/dropbox_api/metadata/file_status.rb,<br /> lib/dropbox_api/metadata/metadata_v2.rb,<br /> lib/dropbox_api/metadata/shared_link.rb,<br /> lib/dropbox_api/metadata/space_usage.rb,<br /> lib/dropbox_api/metadata/access_level.rb,<br /> lib/dropbox_api/metadata/file_request.rb,<br /> lib/dropbox_api/metadata/namespace_id.rb,<br /> lib/dropbox_api/metadata/basic_account.rb,<br /> lib/dropbox_api/metadata/file_category.rb,<br /> lib/dropbox_api/metadata/member_action.rb,<br /> lib/dropbox_api/metadata/shared_folder.rb,<br /> lib/dropbox_api/metadata/media_metadata.rb,<br /> lib/dropbox_api/metadata/photo_metadata.rb,<br /> lib/dropbox_api/metadata/search_options.rb,<br /> lib/dropbox_api/metadata/team_root_info.rb,<br /> lib/dropbox_api/metadata/user_root_info.rb,<br /> lib/dropbox_api/metadata/video_metadata.rb,<br /> lib/dropbox_api/metadata/search_match_v2.rb,<br /> lib/dropbox_api/metadata/search_order_by.rb,<br /> lib/dropbox_api/metadata/link_permissions.rb,<br /> lib/dropbox_api/metadata/space_allocation.rb,<br /> lib/dropbox_api/metadata/team_member_info.rb,<br /> lib/dropbox_api/metadata/member_permission.rb,<br /> lib/dropbox_api/metadata/file_link_metadata.rb,<br /> lib/dropbox_api/metadata/file_member_action.rb,<br /> lib/dropbox_api/metadata/member_action_list.rb,<br /> lib/dropbox_api/metadata/folder_sharing_info.rb,<br /> lib/dropbox_api/metadata/file_categories_list.rb,<br /> lib/dropbox_api/metadata/file_extensions_list.rb,<br /> lib/dropbox_api/metadata/folder_link_metadata.rb,<br /> lib/dropbox_api/metadata/search_match_type_v2.rb,<br /> lib/dropbox_api/metadata/shared_folder_policy.rb,<br /> lib/dropbox_api/metadata/shared_link_metadata.rb,<br /> lib/dropbox_api/metadata/upload_session_cursor.rb,<br /> lib/dropbox_api/metadata/add_file_member_result.rb,<br /> lib/dropbox_api/metadata/member_permission_list.rb,<br /> lib/dropbox_api/metadata/parent_folder_access_info.rb,<br /> lib/dropbox_api/metadata/search_match_field_options.rb,<br /> lib/dropbox_api/metadata/thumbnail_batch_result_data.rb,<br /> lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb</span>
+ +

</dd>

+ +
</dl>
+ +

</div>

+ +

<h2>Defined Under Namespace</h2> <p class=“children”>

+ +
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Metadata/AccessLevel.html" title="DropboxApi::Metadata::AccessLevel (class)">AccessLevel</a></span>, <span class='object_link'><a href="Metadata/AddFileMemberResult.html" title="DropboxApi::Metadata::AddFileMemberResult (class)">AddFileMemberResult</a></span>, <span class='object_link'><a href="Metadata/AddMember.html" title="DropboxApi::Metadata::AddMember (class)">AddMember</a></span>, <span class='object_link'><a href="Metadata/Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span>, <span class='object_link'><a href="Metadata/BasicAccount.html" title="DropboxApi::Metadata::BasicAccount (class)">BasicAccount</a></span>, <span class='object_link'><a href="Metadata/CommitInfo.html" title="DropboxApi::Metadata::CommitInfo (class)">CommitInfo</a></span>, <span class='object_link'><a href="Metadata/Deleted.html" title="DropboxApi::Metadata::Deleted (class)">Deleted</a></span>, <span class='object_link'><a href="Metadata/Dimensions.html" title="DropboxApi::Metadata::Dimensions (class)">Dimensions</a></span>, <span class='object_link'><a href="Metadata/Field.html" title="DropboxApi::Metadata::Field (class)">Field</a></span>, <span class='object_link'><a href="Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span>, <span class='object_link'><a href="Metadata/FileCategoriesList.html" title="DropboxApi::Metadata::FileCategoriesList (class)">FileCategoriesList</a></span>, <span class='object_link'><a href="Metadata/FileCategory.html" title="DropboxApi::Metadata::FileCategory (class)">FileCategory</a></span>, <span class='object_link'><a href="Metadata/FileExtensionsList.html" title="DropboxApi::Metadata::FileExtensionsList (class)">FileExtensionsList</a></span>, <span class='object_link'><a href="Metadata/FileLinkMetadata.html" title="DropboxApi::Metadata::FileLinkMetadata (class)">FileLinkMetadata</a></span>, <span class='object_link'><a href="Metadata/FileMemberAction.html" title="DropboxApi::Metadata::FileMemberAction (class)">FileMemberAction</a></span>, <span class='object_link'><a href="Metadata/FileRequest.html" title="DropboxApi::Metadata::FileRequest (class)">FileRequest</a></span>, <span class='object_link'><a href="Metadata/FileStatus.html" title="DropboxApi::Metadata::FileStatus (class)">FileStatus</a></span>, <span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span>, <span class='object_link'><a href="Metadata/FolderLinkMetadata.html" title="DropboxApi::Metadata::FolderLinkMetadata (class)">FolderLinkMetadata</a></span>, <span class='object_link'><a href="Metadata/FolderSharingInfo.html" title="DropboxApi::Metadata::FolderSharingInfo (class)">FolderSharingInfo</a></span>, <span class='object_link'><a href="Metadata/LinkPermissions.html" title="DropboxApi::Metadata::LinkPermissions (class)">LinkPermissions</a></span>, <span class='object_link'><a href="Metadata/Location.html" title="DropboxApi::Metadata::Location (class)">Location</a></span>, <span class='object_link'><a href="Metadata/MediaInfo.html" title="DropboxApi::Metadata::MediaInfo (class)">MediaInfo</a></span>, <span class='object_link'><a href="Metadata/MediaMetadata.html" title="DropboxApi::Metadata::MediaMetadata (class)">MediaMetadata</a></span>, <span class='object_link'><a href="Metadata/Member.html" title="DropboxApi::Metadata::Member (class)">Member</a></span>, <span class='object_link'><a href="Metadata/MemberAction.html" title="DropboxApi::Metadata::MemberAction (class)">MemberAction</a></span>, <span class='object_link'><a href="Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">MemberActionList</a></span>, <span class='object_link'><a href="Metadata/MemberPermission.html" title="DropboxApi::Metadata::MemberPermission (class)">MemberPermission</a></span>, <span class='object_link'><a href="Metadata/MemberPermissionList.html" title="DropboxApi::Metadata::MemberPermissionList (class)">MemberPermissionList</a></span>, <span class='object_link'><a href="Metadata/MetadataV2.html" title="DropboxApi::Metadata::MetadataV2 (class)">MetadataV2</a></span>, <span class='object_link'><a href="Metadata/Name.html" title="DropboxApi::Metadata::Name (class)">Name</a></span>, <span class='object_link'><a href="Metadata/NamespaceId.html" title="DropboxApi::Metadata::NamespaceId (class)">NamespaceId</a></span>, <span class='object_link'><a href="Metadata/ParentFolderAccessInfo.html" title="DropboxApi::Metadata::ParentFolderAccessInfo (class)">ParentFolderAccessInfo</a></span>, <span class='object_link'><a href="Metadata/PhotoMetadata.html" title="DropboxApi::Metadata::PhotoMetadata (class)">PhotoMetadata</a></span>, <span class='object_link'><a href="Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span>, <span class='object_link'><a href="Metadata/RootInfo.html" title="DropboxApi::Metadata::RootInfo (class)">RootInfo</a></span>, <span class='object_link'><a href="Metadata/SearchMatchFieldOptions.html" title="DropboxApi::Metadata::SearchMatchFieldOptions (class)">SearchMatchFieldOptions</a></span>, <span class='object_link'><a href="Metadata/SearchMatchTypeV2.html" title="DropboxApi::Metadata::SearchMatchTypeV2 (class)">SearchMatchTypeV2</a></span>, <span class='object_link'><a href="Metadata/SearchMatchV2.html" title="DropboxApi::Metadata::SearchMatchV2 (class)">SearchMatchV2</a></span>, <span class='object_link'><a href="Metadata/SearchOptions.html" title="DropboxApi::Metadata::SearchOptions (class)">SearchOptions</a></span>, <span class='object_link'><a href="Metadata/SearchOrderBy.html" title="DropboxApi::Metadata::SearchOrderBy (class)">SearchOrderBy</a></span>, <span class='object_link'><a href="Metadata/SharedFolder.html" title="DropboxApi::Metadata::SharedFolder (class)">SharedFolder</a></span>, <span class='object_link'><a href="Metadata/SharedFolderPolicy.html" title="DropboxApi::Metadata::SharedFolderPolicy (class)">SharedFolderPolicy</a></span>, <span class='object_link'><a href="Metadata/SharedLink.html" title="DropboxApi::Metadata::SharedLink (class)">SharedLink</a></span>, <span class='object_link'><a href="Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">SharedLinkMetadata</a></span>, <span class='object_link'><a href="Metadata/SpaceAllocation.html" title="DropboxApi::Metadata::SpaceAllocation (class)">SpaceAllocation</a></span>, <span class='object_link'><a href="Metadata/SpaceUsage.html" title="DropboxApi::Metadata::SpaceUsage (class)">SpaceUsage</a></span>, <span class='object_link'><a href="Metadata/Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span>, <span class='object_link'><a href="Metadata/Team.html" title="DropboxApi::Metadata::Team (class)">Team</a></span>, <span class='object_link'><a href="Metadata/TeamMemberInfo.html" title="DropboxApi::Metadata::TeamMemberInfo (class)">TeamMemberInfo</a></span>, <span class='object_link'><a href="Metadata/TeamRootInfo.html" title="DropboxApi::Metadata::TeamRootInfo (class)">TeamRootInfo</a></span>, <span class='object_link'><a href="Metadata/ThumbnailBatchResultData.html" title="DropboxApi::Metadata::ThumbnailBatchResultData (class)">ThumbnailBatchResultData</a></span>, <span class='object_link'><a href="Metadata/ThumbnailBatchResultEntry.html" title="DropboxApi::Metadata::ThumbnailBatchResultEntry (class)">ThumbnailBatchResultEntry</a></span>, <span class='object_link'><a href="Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">UploadSessionCursor</a></span>, <span class='object_link'><a href="Metadata/UserRootInfo.html" title="DropboxApi::Metadata::UserRootInfo (class)">UserRootInfo</a></span>, <span class='object_link'><a href="Metadata/VideoMetadata.html" title="DropboxApi::Metadata::VideoMetadata (class)">VideoMetadata</a></span>, <span class='object_link'><a href="Metadata/WriteMode.html" title="DropboxApi::Metadata::WriteMode (class)">WriteMode</a></span>
+ +

</p>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/MiddleWare/DecodeResult_html.html b/doc/docs/DropboxApi/MiddleWare/DecodeResult_html.html new file mode 100644 index 00000000..b91e3939 --- /dev/null +++ b/doc/docs/DropboxApi/MiddleWare/DecodeResult_html.html @@ -0,0 +1,930 @@ + + + + + + +DecodeResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::MiddleWare::DecodeResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::MiddleWare::DecodeResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../MiddleWare.html" title="DropboxApi::MiddleWare (module)">MiddleWare</a></span></span>
+   &raquo; 
+  <span class="title">DecodeResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::MiddleWare::DecodeResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Faraday::Middleware</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">Faraday::Middleware</li>
+
+          <li class="next">DropboxApi::MiddleWare::DecodeResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/middleware/decode_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(rq_env)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#decode-instance_method" title="#decode (instance method)">#<strong>decode</strong>(json)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="call-instance_method">
+
+  #<strong>call</strong>(rq_env)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8 9 10 11 12</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/middleware/decode_result.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_call'>call</span><span +class='lparen'>(</span><span class='id identifier +rubyid_rq_env'>rq_env</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@app</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_rq_env'>rq_env</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_on_complete'>on_complete</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_rs_env'>rs_env</span><span class='op'>|</span>
+  <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_rs_env'>rs_env</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Dropbox-Api-Result</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+    <span class='id identifier rubyid_rs_env'>rs_env</span><span class='lbracket'>[</span><span class='symbol'>:api_result</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_decode'>decode</span> <span class='id identifier rubyid_rs_env'>rs_env</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Dropbox-Api-Result</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+  <span class='kw'>elsif</span> <span class='id identifier rubyid_rs_env'>rs_env</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>content-type</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>application/json</span><span class='tstring_end'>&#39;</span></span>
+    <span class='id identifier rubyid_rs_env'>rs_env</span><span class='lbracket'>[</span><span class='symbol'>:api_result</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_decode'>decode</span> <span class='id identifier rubyid_rs_env'>rs_env</span><span class='lbracket'>[</span><span class='symbol'>:body</span><span class='rbracket'>]</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="decode-instance_method">
+
+  #<strong>decode</strong>(json)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

14 15 16 17 18 19 20 21 22 23</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/middleware/decode_result.rb', line 14</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_decode'>decode</span><span +class='lparen'>(</span><span class='id identifier +rubyid_json'>json</span><span +class='rparen'>)</span>

+ +
<span class='comment'># Dropbox may send a response with the string &#39;null&#39; in its body, this
+ +

</span> <span class='comment'># would be a void +result. `add_folder_member` is an example of an </span> <span +class='comment'># endpoint without return values. </span> +<span class='kw'>if</span> <span class='id +identifier rubyid_json'>json</span> <span +class='op'>==</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>null</span><span +class='tstring_end'>&#39;</span></span>

+ +
  <span class='lbrace'>{</span><span class='rbrace'>}</span>
+<span class='kw'>else</span>
+  <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span> <span class='id identifier rubyid_json'>json</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/MiddleWare/PathRoot_html.html b/doc/docs/DropboxApi/MiddleWare/PathRoot_html.html new file mode 100644 index 00000000..4ac47759 --- /dev/null +++ b/doc/docs/DropboxApi/MiddleWare/PathRoot_html.html @@ -0,0 +1,1039 @@ + + + + + + +PathRoot.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::MiddleWare::PathRoot
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::MiddleWare::PathRoot";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (P)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../MiddleWare.html" title="DropboxApi::MiddleWare (module)">MiddleWare</a></span></span>
+   &raquo; 
+  <span class="title">PathRoot</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::MiddleWare::PathRoot
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Faraday::Middleware</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">Faraday::Middleware</li>
+
+          <li class="next">DropboxApi::MiddleWare::PathRoot</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/middleware/path_root.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="HEADER_NAME-constant" class="">HEADER_NAME =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Dropbox-API-Path-Root</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(env)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(app, options = {})  &#x21d2; PathRoot </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of PathRoot.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#namespace_id-instance_method" title="#namespace_id (instance method)">#<strong>namespace_id</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#namespace_id_header_value-instance_method" title="#namespace_id_header_value (instance method)">#<strong>namespace_id_header_value</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(app, options = {})  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::MiddleWare::PathRoot (class)">PathRoot</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of PathRoot.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

6 7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/middleware/path_root.rb', line 6</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_app'>app</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span> <span +class='op'>=</span> <span +class='lbrace'>{</span><span +class='rbrace'>}</span><span +class='rparen'>)</span>

+ +
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
+<span class='ivar'>@options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="call-instance_method">
+
+  #<strong>call</strong>(env)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

27 28 29 30 31 32 33</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/middleware/path_root.rb', line 27</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_call'>call</span><span +class='lparen'>(</span><span class='id identifier +rubyid_env'>env</span><span +class='rparen'>)</span>

+ +
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_namespace_id'>namespace_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="#HEADER_NAME-constant" title="DropboxApi::MiddleWare::PathRoot::HEADER_NAME (constant)">HEADER_NAME</a></span></span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='id identifier rubyid_namespace_id_header_value'>namespace_id_header_value</span>
+<span class='kw'>end</span>
+
+<span class='ivar'>@app</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='id identifier rubyid_env'>env</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="namespace_id-instance_method">
+
+  #<strong>namespace_id</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

11 12 13 14 15 16 17</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/middleware/path_root.rb', line 11</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_namespace_id'>namespace_id</span>

+ +
<span class='kw'>if</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='symbol'>:namespace_id</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='kw'>return</span> <span class='kw'>nil</span>
+<span class='kw'>else</span>
+  <span class='kw'>return</span> <span class='ivar'>@options</span><span class='lbracket'>[</span><span class='symbol'>:namespace_id</span><span class='rbracket'>]</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="namespace_id_header_value-instance_method">
+
+  #<strong>namespace_id_header_value</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

19 20 21 22 23 24 25</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/middleware/path_root.rb', line 19</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_namespace_id_header_value'>namespace_id_header_value</span>

+ +
<span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/NamespaceId.html" title="DropboxApi::Metadata::NamespaceId (class)">NamespaceId</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='lbrace'>{</span>
+    <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>namespace_id</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_namespace_id'>namespace_id</span>
+  <span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_hash'><span class='object_link'><a href="../Metadata/Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">to_hash</a></span></span>
+<span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/MiddleWare/Stack_html.html b/doc/docs/DropboxApi/MiddleWare/Stack_html.html new file mode 100644 index 00000000..230f5bcd --- /dev/null +++ b/doc/docs/DropboxApi/MiddleWare/Stack_html.html @@ -0,0 +1,1086 @@ + + + + + + +Stack.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::MiddleWare::Stack
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::MiddleWare::Stack";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../MiddleWare.html" title="DropboxApi::MiddleWare (module)">MiddleWare</a></span></span>
+   &raquo; 
+  <span class="title">Stack</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::MiddleWare::Stack
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::MiddleWare::Stack</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/middleware/stack.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#adapter=-instance_method" title="#adapter= (instance method)">#<strong>adapter=</strong>(value)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#append-instance_method" title="#append (instance method)">#<strong>append</strong>(&amp;block)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#apply-instance_method" title="#apply (instance method)">#<strong>apply</strong>(connection) {|connection| ... } &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>  &#x21d2; Stack </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of Stack.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#prepend-instance_method" title="#prepend (instance method)">#<strong>prepend</strong>(&amp;block)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
</ul>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::MiddleWare::Stack (class)">Stack</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of Stack.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/middleware/stack.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span>

+ +
<span class='ivar'>@prependable</span><span class='comma'>,</span> <span class='ivar'>@appendable</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="adapter=-instance_method">
+
+  #<strong>adapter=</strong>(value)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/middleware/stack.rb', line 16</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_adapter='>adapter=</span><span +class='lparen'>(</span><span class='id identifier +rubyid_value'>value</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@adapter</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="append-instance_method">
+
+  #<strong>append</strong>(&amp;block)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/middleware/stack.rb', line 12</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_append'>append</span><span +class='lparen'>(</span><span +class='op'>&amp;</span><span class='id +identifier rubyid_block'>block</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@appendable</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_block'>block</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="apply-instance_method">
+
+  #<strong>apply</strong>(connection) {|connection| ... } &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+
+</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Yields:</p> <ul class=“yield”>

+ +
<li>
+
+    <span class='type'>(<tt>connection</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

20 21 22 23 24 25 26 27</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/middleware/stack.rb', line 20</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_apply'>apply</span><span +class='lparen'>(</span><span class='id identifier +rubyid_connection'>connection</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@prependable</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_block'>block</span><span class='op'>|</span> <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_yield'>yield</span><span class='lparen'>(</span><span class='id identifier rubyid_connection'>connection</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
+<span class='kw'>yield</span> <span class='id identifier rubyid_connection'>connection</span>
+<span class='ivar'>@appendable</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_block'>block</span><span class='op'>|</span> <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_yield'>yield</span><span class='lparen'>(</span><span class='id identifier rubyid_connection'>connection</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
+
+<span class='comment'># Adapter must be the last middleware configured
+ +

</span> <span class='id identifier +rubyid_connection'>connection</span><span +class='period'>.</span><span class='id identifier +rubyid_adapter'>adapter</span><span +class='lparen'>(</span><span +class='ivar'>@adapter</span> <span +class='op'>||</span> <span +class='const'>Faraday</span><span +class='period'>.</span><span class='id identifier +rubyid_default_adapter'>default_adapter</span><span +class='rparen'>)</span> <span +class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="prepend-instance_method">
+
+  #<strong>prepend</strong>(&amp;block)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/middleware/stack.rb', line 8</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_prepend'>prepend</span><span +class='lparen'>(</span><span +class='op'>&amp;</span><span class='id +identifier rubyid_block'>block</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@prependable</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_block'>block</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/MiddleWare_html.html b/doc/docs/DropboxApi/MiddleWare_html.html new file mode 100644 index 00000000..aa6e3594 --- /dev/null +++ b/doc/docs/DropboxApi/MiddleWare_html.html @@ -0,0 +1,800 @@ + + + + + + +MiddleWare.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Module: DropboxApi::MiddleWare
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::MiddleWare";
+relpath = '../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+   &raquo; 
+  <span class="title">MiddleWare</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Module: DropboxApi::MiddleWare
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/middleware/stack.rb<span class="defines">,<br />
+lib/dropbox_api/middleware/path_root.rb,<br /> lib/dropbox_api/middleware/decode_result.rb</span>
+ +

</dd>

+ +
</dl>
+ +

</div>

+ +

<h2>Defined Under Namespace</h2> <p class=“children”>

+ +
<strong class="classes">Classes:</strong> <span class='object_link'><a href="MiddleWare/DecodeResult.html" title="DropboxApi::MiddleWare::DecodeResult (class)">DecodeResult</a></span>, <span class='object_link'><a href="MiddleWare/PathRoot.html" title="DropboxApi::MiddleWare::PathRoot (class)">PathRoot</a></span>, <span class='object_link'><a href="MiddleWare/Stack.html" title="DropboxApi::MiddleWare::Stack (class)">Stack</a></span>
+ +

</p>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/OptionsValidator_html.html b/doc/docs/DropboxApi/OptionsValidator_html.html new file mode 100644 index 00000000..6d74d726 --- /dev/null +++ b/doc/docs/DropboxApi/OptionsValidator_html.html @@ -0,0 +1,904 @@ + + + + + + +OptionsValidator.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Module: DropboxApi::OptionsValidator
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::OptionsValidator";
+relpath = '../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../_index.html">Index (O)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+   &raquo; 
+  <span class="title">OptionsValidator</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Module: DropboxApi::OptionsValidator
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Included in:</dt>
+  <dd><span class='object_link'><a href="ChunkedUploader.html" title="DropboxApi::ChunkedUploader (class)">ChunkedUploader</a></span>, <span class='object_link'><a href="Endpoints/Files/CopyBatch.html" title="DropboxApi::Endpoints::Files::CopyBatch (class)">Endpoints::Files::CopyBatch</a></span>, <span class='object_link'><a href="Endpoints/Files/CreateFolderBatch.html" title="DropboxApi::Endpoints::Files::CreateFolderBatch (class)">Endpoints::Files::CreateFolderBatch</a></span>, <span class='object_link'><a href="Endpoints/Files/Delete.html" title="DropboxApi::Endpoints::Files::Delete (class)">Endpoints::Files::Delete</a></span>, <span class='object_link'><a href="Endpoints/Files/GetMetadata.html" title="DropboxApi::Endpoints::Files::GetMetadata (class)">Endpoints::Files::GetMetadata</a></span>, <span class='object_link'><a href="Endpoints/Files/GetThumbnail.html" title="DropboxApi::Endpoints::Files::GetThumbnail (class)">Endpoints::Files::GetThumbnail</a></span>, <span class='object_link'><a href="Endpoints/Files/GetThumbnailBatch.html" title="DropboxApi::Endpoints::Files::GetThumbnailBatch (class)">Endpoints::Files::GetThumbnailBatch</a></span>, <span class='object_link'><a href="Endpoints/Files/ListFolder.html" title="DropboxApi::Endpoints::Files::ListFolder (class)">Endpoints::Files::ListFolder</a></span>, <span class='object_link'><a href="Endpoints/Files/ListFolderGetLatestCursor.html" title="DropboxApi::Endpoints::Files::ListFolderGetLatestCursor (class)">Endpoints::Files::ListFolderGetLatestCursor</a></span>, <span class='object_link'><a href="Endpoints/Files/ListFolderLongpoll.html" title="DropboxApi::Endpoints::Files::ListFolderLongpoll (class)">Endpoints::Files::ListFolderLongpoll</a></span>, <span class='object_link'><a href="Endpoints/Files/ListRevisions.html" title="DropboxApi::Endpoints::Files::ListRevisions (class)">Endpoints::Files::ListRevisions</a></span>, <span class='object_link'><a href="Endpoints/Files/Move.html" title="DropboxApi::Endpoints::Files::Move (class)">Endpoints::Files::Move</a></span>, <span class='object_link'><a href="Endpoints/Files/PermanentlyDelete.html" title="DropboxApi::Endpoints::Files::PermanentlyDelete (class)">Endpoints::Files::PermanentlyDelete</a></span>, <span class='object_link'><a href="Endpoints/Files/Search.html" title="DropboxApi::Endpoints::Files::Search (class)">Endpoints::Files::Search</a></span>, <span class='object_link'><a href="Endpoints/Files/SearchContinue.html" title="DropboxApi::Endpoints::Files::SearchContinue (class)">Endpoints::Files::SearchContinue</a></span>, <span class='object_link'><a href="Endpoints/Files/Upload.html" title="DropboxApi::Endpoints::Files::Upload (class)">Endpoints::Files::Upload</a></span>, <span class='object_link'><a href="Endpoints/Files/UploadSessionAppendV2.html" title="DropboxApi::Endpoints::Files::UploadSessionAppendV2 (class)">Endpoints::Files::UploadSessionAppendV2</a></span>, <span class='object_link'><a href="Endpoints/Files/UploadSessionFinish.html" title="DropboxApi::Endpoints::Files::UploadSessionFinish (class)">Endpoints::Files::UploadSessionFinish</a></span>, <span class='object_link'><a href="Endpoints/Files/UploadSessionStart.html" title="DropboxApi::Endpoints::Files::UploadSessionStart (class)">Endpoints::Files::UploadSessionStart</a></span>, <span class='object_link'><a href="Endpoints/Sharing/AddFileMember.html" title="DropboxApi::Endpoints::Sharing::AddFileMember (class)">Endpoints::Sharing::AddFileMember</a></span>, <span class='object_link'><a href="Endpoints/Sharing/AddFolderMember.html" title="DropboxApi::Endpoints::Sharing::AddFolderMember (class)">Endpoints::Sharing::AddFolderMember</a></span>, <span class='object_link'><a href="Endpoints/Sharing/CreateSharedLinkWithSettings.html" title="DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings (class)">Endpoints::Sharing::CreateSharedLinkWithSettings</a></span>, <span class='object_link'><a href="Endpoints/Sharing/GetSharedLinkMetadata.html" title="DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata (class)">Endpoints::Sharing::GetSharedLinkMetadata</a></span>, <span class='object_link'><a href="Endpoints/Sharing/ListFileMembers.html" title="DropboxApi::Endpoints::Sharing::ListFileMembers (class)">Endpoints::Sharing::ListFileMembers</a></span>, <span class='object_link'><a href="Endpoints/Sharing/ListFolderMembers.html" title="DropboxApi::Endpoints::Sharing::ListFolderMembers (class)">Endpoints::Sharing::ListFolderMembers</a></span>, <span class='object_link'><a href="Endpoints/Sharing/ListSharedLinks.html" title="DropboxApi::Endpoints::Sharing::ListSharedLinks (class)">Endpoints::Sharing::ListSharedLinks</a></span>, <span class='object_link'><a href="Endpoints/Sharing/ShareFolder.html" title="DropboxApi::Endpoints::Sharing::ShareFolder (class)">Endpoints::Sharing::ShareFolder</a></span></dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/options_validator.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#validate_options-instance_method" title="#validate_options (instance method)">#<strong>validate_options</strong>(valid_option_keys, options)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Takes in a list of valid option keys and a hash of options.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="validate_options-instance_method">
+
+  #<strong>validate_options</strong>(valid_option_keys, options)  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Takes in a list of valid option keys and a hash of options. If one of the
+ +

keys in the hash is invalid an ArgumentError will be raised.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +
<p class="tag_title">Parameters:</p>
+ +

<ul class=“param”>

+ +
<li>
+
+    <span class='name'>valid_option_keys</span>
+
+    <span class='type'></span>
+
+    &mdash;
+    <div class='inline'><p>List of valid keys for the options hash.</p>
+ +

</div>

+ +
</li>
+
+<li>
+
+    <span class='name'>options</span>
+
+    <span class='type'>(<tt>Hash</tt>)</span>
+
+    &mdash;
+    <div class='inline'><p>Options hash.</p>
+ +

</div>

+ +
</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

9 10 11 12 13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/options_validator.rb', line 9</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_validate_options'>validate_options</span><span +class='lparen'>(</span><span class='id identifier +rubyid_valid_option_keys'>valid_option_keys</span><span +class='comma'>,</span> <span class='id identifier +rubyid_options'>options</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span>
+  <span class='kw'>unless</span> <span class='id identifier rubyid_valid_option_keys'>valid_option_keys</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid option `</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>`</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/ResultBuilder_html.html b/doc/docs/DropboxApi/ResultBuilder_html.html new file mode 100644 index 00000000..48e872ee --- /dev/null +++ b/doc/docs/DropboxApi/ResultBuilder_html.html @@ -0,0 +1,1164 @@ + + + + + + +ResultBuilder.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::ResultBuilder
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::ResultBuilder";
+relpath = '../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+   &raquo; 
+  <span class="title">ResultBuilder</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::ResultBuilder
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::ResultBuilder</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/result_builder.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build-instance_method" title="#build (instance method)">#<strong>build</strong>(result_class)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_error-instance_method" title="#build_error (instance method)">#<strong>build_error</strong>(error_type)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#error-instance_method" title="#error (instance method)">#<strong>error</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#error_summary-instance_method" title="#error_summary (instance method)">#<strong>error_summary</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#has_error%3F-instance_method" title="#has_error? (instance method)">#<strong>has_error?</strong>  &#x21d2; Boolean </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(response_data)  &#x21d2; ResultBuilder </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of ResultBuilder.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#success%3F-instance_method" title="#success? (instance method)">#<strong>success?</strong>  &#x21d2; Boolean </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
</ul>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(response_data)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::ResultBuilder (class)">ResultBuilder</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of ResultBuilder.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/result_builder.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_response_data'>response_data</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@response_data</span> <span class='op'>=</span> <span class='id identifier rubyid_response_data'>response_data</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build-instance_method">
+
+  #<strong>build</strong>(result_class)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

24 25 26</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/result_builder.rb', line 24</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build'>build</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result_class'>result_class</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_result_class'>result_class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@response_data</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_error-instance_method">
+
+  #<strong>build_error</strong>(error_type)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

28 29 30</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/result_builder.rb', line 28</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_error'>build_error</span><span +class='lparen'>(</span><span class='id identifier +rubyid_error_type'>error_type</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_error_type'>error_type</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='id identifier rubyid_error_summary'>error_summary</span><span class='comma'>,</span> <span class='id identifier rubyid_error'>error</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="error-instance_method">
+
+  #<strong>error</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/result_builder.rb', line 12</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_error'>error</span>

+ +
<span class='ivar'>@response_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="error_summary-instance_method">
+
+  #<strong>error_summary</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/result_builder.rb', line 8</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_error_summary'>error_summary</span>

+ +
<span class='ivar'>@response_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error_summary</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='ivar'>@response_data</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Hash</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="has_error?-instance_method">
+
+  #<strong>has_error?</strong>  &#x21d2; <tt>Boolean</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+
+</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>Boolean</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/result_builder.rb', line 16</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_has_error?'>has_error?</span>

+ +
<span class='op'>!</span><span class='id identifier rubyid_error_summary'>error_summary</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="success?-instance_method">
+
+  #<strong>success?</strong>  &#x21d2; <tt>Boolean</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+
+</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>Boolean</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

20 21 22</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/result_builder.rb', line 20</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_success?'>success?</span>

+ +
<span class='op'>!</span><span class='id identifier rubyid_has_error?'>has_error?</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/AddFileMemberResultList_html.html b/doc/docs/DropboxApi/Results/AddFileMemberResultList_html.html new file mode 100644 index 00000000..7248c5b1 --- /dev/null +++ b/doc/docs/DropboxApi/Results/AddFileMemberResultList_html.html @@ -0,0 +1,901 @@ + + + + + + +AddFileMemberResultList.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::AddFileMemberResultList
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::AddFileMemberResultList";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (A)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">AddFileMemberResultList</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::AddFileMemberResultList
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Array</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">Array</li>
+
+          <li class="next">DropboxApi::Results::AddFileMemberResultList</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/add_file_member_result_list.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example of a result of the <code>add_file_member</code> endpoint:
+[{
+  &quot;member&quot;:{
+    &quot;.tag&quot;: &quot;email&quot;,
+    &quot;email&quot;: &quot;<a href="mailto:somebody@test.com">somebody@test.com</a>&quot;
+  },
+  &quot;result&quot;: {
+    &quot;.tag&quot;: &quot;success&quot;,
+    &quot;success&quot;: {
+      &quot;.tag&quot;: &quot;viewer&quot;
+    }
+  }
+}]</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(members)  &#x21d2; AddFileMemberResultList </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of AddFileMemberResultList.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(members)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of AddFileMemberResultList.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/add_file_member_result_list.rb', line 17</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_members'>members</span><span +class='rparen'>)</span>

+ +
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_members'>members</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_m'>m</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/AddFileMemberResult.html" title="DropboxApi::Metadata::AddFileMemberResult (class)">AddFileMemberResult</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span> <span class='id identifier rubyid_m'>m</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/Base_html.html b/doc/docs/DropboxApi/Results/Base_html.html new file mode 100644 index 00000000..7c438fa1 --- /dev/null +++ b/doc/docs/DropboxApi/Results/Base_html.html @@ -0,0 +1,884 @@ + + + + + + +Base.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::Base
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::Base";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (B)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">Base</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::Base
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::Results::Base</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/base.rb</dd>
+</dl>
+ +

</div>

+ +

<div id=“subclasses”>

+ +
<h2>Direct Known Subclasses</h2>
+<p class="children"><span class='object_link'><a href="CopyBatchResult.html" title="DropboxApi::Results::CopyBatchResult (class)">CopyBatchResult</a></span>, <span class='object_link'><a href="CreateFolderBatchResult.html" title="DropboxApi::Results::CreateFolderBatchResult (class)">CreateFolderBatchResult</a></span>, <span class='object_link'><a href="CreateFolderBatchResultEntry.html" title="DropboxApi::Results::CreateFolderBatchResultEntry (class)">CreateFolderBatchResultEntry</a></span>, <span class='object_link'><a href="DeleteBatchResult.html" title="DropboxApi::Results::DeleteBatchResult (class)">DeleteBatchResult</a></span>, <span class='object_link'><a href="DeleteBatchResultEntry.html" title="DropboxApi::Results::DeleteBatchResultEntry (class)">DeleteBatchResultEntry</a></span>, <span class='object_link'><a href="GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">GetCopyReferenceResult</a></span>, <span class='object_link'><a href="GetTemporaryLinkResult.html" title="DropboxApi::Results::GetTemporaryLinkResult (class)">GetTemporaryLinkResult</a></span>, <span class='object_link'><a href="GetThumbnailBatchResult.html" title="DropboxApi::Results::GetThumbnailBatchResult (class)">GetThumbnailBatchResult</a></span>, <span class='object_link'><a href="ListFolderGetLatestCursorResult.html" title="DropboxApi::Results::ListFolderGetLatestCursorResult (class)">ListFolderGetLatestCursorResult</a></span>, <span class='object_link'><a href="ListFolderLongpollResult.html" title="DropboxApi::Results::ListFolderLongpollResult (class)">ListFolderLongpollResult</a></span>, <span class='object_link'><a href="ListFolderResult.html" title="DropboxApi::Results::ListFolderResult (class)">ListFolderResult</a></span>, <span class='object_link'><a href="ListRevisionsResult.html" title="DropboxApi::Results::ListRevisionsResult (class)">ListRevisionsResult</a></span>, <span class='object_link'><a href="ListSharedLinksResult.html" title="DropboxApi::Results::ListSharedLinksResult (class)">ListSharedLinksResult</a></span>, <span class='object_link'><a href="RelocationBatchResult.html" title="DropboxApi::Results::RelocationBatchResult (class)">RelocationBatchResult</a></span>, <span class='object_link'><a href="RelocationBatchResultEntry.html" title="DropboxApi::Results::RelocationBatchResultEntry (class)">RelocationBatchResultEntry</a></span>, <span class='object_link'><a href="SaveCopyReferenceResult.html" title="DropboxApi::Results::SaveCopyReferenceResult (class)">SaveCopyReferenceResult</a></span>, <span class='object_link'><a href="SaveUrlJobStatus.html" title="DropboxApi::Results::SaveUrlJobStatus (class)">SaveUrlJobStatus</a></span>, <span class='object_link'><a href="SaveUrlResult.html" title="DropboxApi::Results::SaveUrlResult (class)">SaveUrlResult</a></span>, <span class='object_link'><a href="SearchV2Result.html" title="DropboxApi::Results::SearchV2Result (class)">SearchV2Result</a></span>, <span class='object_link'><a href="SharedFileMembers.html" title="DropboxApi::Results::SharedFileMembers (class)">SharedFileMembers</a></span>, <span class='object_link'><a href="SharedFolderMembers.html" title="DropboxApi::Results::SharedFolderMembers (class)">SharedFolderMembers</a></span>, <span class='object_link'><a href="UploadSessionStart.html" title="DropboxApi::Results::UploadSessionStart (class)">UploadSessionStart</a></span>, <span class='object_link'><a href="VoidResult.html" title="DropboxApi::Results::VoidResult (class)">VoidResult</a></span></p>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(result_data)  &#x21d2; Base </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of Base.</p>
+ +

</div></span>

+ +

</li>

+ +
</ul>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(result_data)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Results::Base (class)">Base</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of Base.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/base.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result_data'>result_data</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_result_data'>result_data</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/BasicAccountBatch_html.html b/doc/docs/DropboxApi/Results/BasicAccountBatch_html.html new file mode 100644 index 00000000..f4fe79ac --- /dev/null +++ b/doc/docs/DropboxApi/Results/BasicAccountBatch_html.html @@ -0,0 +1,878 @@ + + + + + + +BasicAccountBatch.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::BasicAccountBatch
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::BasicAccountBatch";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (B)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">BasicAccountBatch</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::BasicAccountBatch
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Array</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">Array</li>
+
+          <li class="next">DropboxApi::Results::BasicAccountBatch</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/basic_account_batch.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(accounts)  &#x21d2; BasicAccountBatch </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of BasicAccountBatch.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<div id="constructor_details" class="method_details_list">
+<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(accounts)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Results::BasicAccountBatch (class)">BasicAccountBatch</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of BasicAccountBatch.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/basic_account_batch.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_accounts'>accounts</span><span +class='rparen'>)</span>

+ +
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_accounts'>accounts</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/BasicAccount.html" title="DropboxApi::Metadata::BasicAccount (class)">BasicAccount</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span> <span class='id identifier rubyid_a'>a</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/CopyBatchResult_html.html b/doc/docs/DropboxApi/Results/CopyBatchResult_html.html new file mode 100644 index 00000000..4e7a3969 --- /dev/null +++ b/doc/docs/DropboxApi/Results/CopyBatchResult_html.html @@ -0,0 +1,885 @@ + + + + + + +CopyBatchResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::CopyBatchResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::CopyBatchResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">CopyBatchResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::CopyBatchResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::CopyBatchResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/copy_batch_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(result_data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(result_data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8 9 10 11 12 13</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/copy_batch_result.rb', line 4</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result_data'>result_data</span><span +class='rparen'>)</span>

+ +
<span class='kw'>case</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>complete</span><span class='tstring_end'>&#39;</span></span>
+  <span class='const'><span class='object_link'><a href="RelocationBatchResult.html" title="DropboxApi::Results::RelocationBatchResult (class)">RelocationBatchResult</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="RelocationBatchResult.html#new-class_method" title="DropboxApi::Results::RelocationBatchResult.new (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_result_data'>result_data</span><span class='rparen'>)</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown result type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/CreateFolderBatchResultEntry_html.html b/doc/docs/DropboxApi/Results/CreateFolderBatchResultEntry_html.html new file mode 100644 index 00000000..a4b43ba9 --- /dev/null +++ b/doc/docs/DropboxApi/Results/CreateFolderBatchResultEntry_html.html @@ -0,0 +1,905 @@ + + + + + + +CreateFolderBatchResultEntry.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::CreateFolderBatchResultEntry
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::CreateFolderBatchResultEntry";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">CreateFolderBatchResultEntry</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::CreateFolderBatchResultEntry
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::CreateFolderBatchResultEntry</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/create_folder_batch_result_entry.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(result_data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(result_data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8 9 10 11 12 13 14 15 16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/create_folder_batch_result_entry.rb', line 4</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result_data'>result_data</span><span +class='rparen'>)</span>

+ +
<span class='kw'>case</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>success</span><span class='tstring_end'>&#39;</span></span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>metadata</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>failure</span><span class='tstring_end'>&#39;</span></span>
+  <span class='comment'># At the moment, this is a `CreateFolderEntryError` which is an open
+ +

</span> <span class='comment'># union that can only +be a `WriteError`. In the future, more errors </span> <span +class='comment'># could be added to the API which means +we&#39;d have to implement the </span> <span +class='comment'># actual `CreateFolderEntryError` class. +</span> <span class='const'><span +class='object_link'><a href=“../../DropboxApi.html” +title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“../Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“../Errors/WriteError.html” title=“DropboxApi::Errors::WriteError +(class)”>WriteError</a></span></span>

+ +
    <span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Folder operation failed</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>failure</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>path</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown result type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/CreateFolderBatchResult_html.html b/doc/docs/DropboxApi/Results/CreateFolderBatchResult_html.html new file mode 100644 index 00000000..8b5b93bc --- /dev/null +++ b/doc/docs/DropboxApi/Results/CreateFolderBatchResult_html.html @@ -0,0 +1,903 @@ + + + + + + +CreateFolderBatchResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::CreateFolderBatchResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::CreateFolderBatchResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (C)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">CreateFolderBatchResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::CreateFolderBatchResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::CreateFolderBatchResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/create_folder_batch_result.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Result returned by <span class='object_link'><a href="../Client.html#create_folder_batch-instance_method" title="DropboxApi::Client#create_folder_batch (method)">Client#create_folder_batch</a></span> that may either launch an
+ +

asynchronous job or complete synchronously.</p>

+ +

<p>The value will be either a job id or a list of job +statuses.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(result_data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(result_data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

8 9 10 11 12 13 14 15 16 17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/create_folder_batch_result.rb', line 8</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result_data'>result_data</span><span +class='rparen'>)</span>

+ +
<span class='kw'>case</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_result_data'>result_data</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>complete</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entries</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span>
+    <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="CreateFolderBatchResultEntry.html" title="DropboxApi::Results::CreateFolderBatchResultEntry (class)">CreateFolderBatchResultEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="CreateFolderBatchResultEntry.html#new-class_method" title="DropboxApi::Results::CreateFolderBatchResultEntry.new (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_entry'>entry</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown result type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/DeleteBatchResultEntry_html.html b/doc/docs/DropboxApi/Results/DeleteBatchResultEntry_html.html new file mode 100644 index 00000000..6f9a0e0f --- /dev/null +++ b/doc/docs/DropboxApi/Results/DeleteBatchResultEntry_html.html @@ -0,0 +1,886 @@ + + + + + + +DeleteBatchResultEntry.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::DeleteBatchResultEntry
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::DeleteBatchResultEntry";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">DeleteBatchResultEntry</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::DeleteBatchResultEntry
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::DeleteBatchResultEntry</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/delete_batch_result_entry.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(result_data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(result_data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8 9 10 11 12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/delete_batch_result_entry.rb', line 4</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result_data'>result_data</span><span +class='rparen'>)</span>

+ +
<span class='kw'>case</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>success</span><span class='tstring_end'>&#39;</span></span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Resource.html#new-class_method" title="DropboxApi::Metadata::Resource.new (method)">new</a></span></span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>metadata</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>failure</span><span class='tstring_end'>&#39;</span></span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Errors/DeleteError.html" title="DropboxApi::Errors::DeleteError (class)">DeleteError</a></span></span>
+    <span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Delete operation failed</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>failure</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown result type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/DeleteBatchResult_html.html b/doc/docs/DropboxApi/Results/DeleteBatchResult_html.html new file mode 100644 index 00000000..1576caba --- /dev/null +++ b/doc/docs/DropboxApi/Results/DeleteBatchResult_html.html @@ -0,0 +1,903 @@ + + + + + + +DeleteBatchResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::DeleteBatchResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::DeleteBatchResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (D)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">DeleteBatchResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::DeleteBatchResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::DeleteBatchResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/delete_batch_result.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Result returned by <span class='object_link'><a href="../Client.html#delete_batch-instance_method" title="DropboxApi::Client#delete_batch (method)">Client#delete_batch</a></span> that may either launch an
+ +

asynchronous job or complete synchronously.</p>

+ +

<p>The value will be either a job id or a list of job +statuses.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(result_data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(result_data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

8 9 10 11 12 13 14 15 16 17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/delete_batch_result.rb', line 8</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result_data'>result_data</span><span +class='rparen'>)</span>

+ +
<span class='kw'>case</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_result_data'>result_data</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>complete</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entries</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span>
+    <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DeleteBatchResultEntry.html" title="DropboxApi::Results::DeleteBatchResultEntry (class)">DeleteBatchResultEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DeleteBatchResultEntry.html#new-class_method" title="DropboxApi::Results::DeleteBatchResultEntry.new (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_entry'>entry</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown result type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/GetCopyReferenceResult_html.html b/doc/docs/DropboxApi/Results/GetCopyReferenceResult_html.html new file mode 100644 index 00000000..74b19e88 --- /dev/null +++ b/doc/docs/DropboxApi/Results/GetCopyReferenceResult_html.html @@ -0,0 +1,989 @@ + + + + + + +GetCopyReferenceResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::GetCopyReferenceResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::GetCopyReferenceResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">GetCopyReferenceResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::GetCopyReferenceResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::GetCopyReferenceResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/get_copy_reference_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#copy_reference-instance_method" title="#copy_reference (instance method)">#<strong>copy_reference</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>A copy reference to the file or folder.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#expires-instance_method" title="#expires (instance method)">#<strong>expires</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>The expiration date of the copy reference.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#resource-instance_method" title="#resource (instance method)">#<strong>resource</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Metadata of the file or folder.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="copy_reference-instance_method">
+
+  #<strong>copy_reference</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>A copy reference to the file or folder.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

10 11 12</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/get_copy_reference_result.rb', line 10</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_copy_reference'>copy_reference</span>

+ +
<span class='ivar'>@copy_reference</span> <span class='op'>||=</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>copy_reference</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="expires-instance_method">
+
+  #<strong>expires</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>The expiration date of the copy reference.
+ +

This value is currently set to be far enough in the future so that +expiration is effectively not an issue.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/get_copy_reference_result.rb', line 17</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_expires'>expires</span>

+ +
<span class='ivar'>@expires</span> <span class='op'>||=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>expires</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="resource-instance_method">
+
+  #<strong>resource</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Metadata of the file or folder.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

5 6 7</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/get_copy_reference_result.rb', line 5</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_resource'>resource</span>

+ +
<span class='ivar'>@resource</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Resource.html#new-class_method" title="DropboxApi::Metadata::Resource.new (method)">new</a></span></span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>metadata</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/GetTemporaryLinkResult_html.html b/doc/docs/DropboxApi/Results/GetTemporaryLinkResult_html.html new file mode 100644 index 00000000..42a1de64 --- /dev/null +++ b/doc/docs/DropboxApi/Results/GetTemporaryLinkResult_html.html @@ -0,0 +1,913 @@ + + + + + + +GetTemporaryLinkResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::GetTemporaryLinkResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::GetTemporaryLinkResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">GetTemporaryLinkResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::GetTemporaryLinkResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::GetTemporaryLinkResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/get_temporary_link_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#file-instance_method" title="#file (instance method)">#<strong>file</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#link-instance_method" title="#link (instance method)">#<strong>link</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="file-instance_method">
+
+  #<strong>file</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/get_temporary_link_result.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_file'>file</span>

+ +
<span class='ivar'>@file</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>metadata</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="link-instance_method">
+
+  #<strong>link</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/get_temporary_link_result.rb', line 8</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_link'>link</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>link</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/GetThumbnailBatchResult_html.html b/doc/docs/DropboxApi/Results/GetThumbnailBatchResult_html.html new file mode 100644 index 00000000..3950066d --- /dev/null +++ b/doc/docs/DropboxApi/Results/GetThumbnailBatchResult_html.html @@ -0,0 +1,875 @@ + + + + + + +GetThumbnailBatchResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::GetThumbnailBatchResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::GetThumbnailBatchResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (G)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">GetThumbnailBatchResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::GetThumbnailBatchResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::GetThumbnailBatchResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/get_thumbnail_batch_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#entries-instance_method" title="#entries (instance method)">#<strong>entries</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="entries-instance_method">
+
+  #<strong>entries</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/get_thumbnail_batch_result.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_entries'>entries</span>

+ +
<span class='ivar'>@entries</span> <span class='op'>||=</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entries</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/ThumbnailBatchResultEntry.html" title="DropboxApi::Metadata::ThumbnailBatchResultEntry (class)">ThumbnailBatchResultEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/ThumbnailBatchResultEntry.html#new-class_method" title="DropboxApi::Metadata::ThumbnailBatchResultEntry.new (method)">new</a></span></span> <span class='id identifier rubyid_entry'>entry</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/ListFolderGetLatestCursorResult_html.html b/doc/docs/DropboxApi/Results/ListFolderGetLatestCursorResult_html.html new file mode 100644 index 00000000..85bdf1dd --- /dev/null +++ b/doc/docs/DropboxApi/Results/ListFolderGetLatestCursorResult_html.html @@ -0,0 +1,873 @@ + + + + + + +ListFolderGetLatestCursorResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::ListFolderGetLatestCursorResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::ListFolderGetLatestCursorResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">ListFolderGetLatestCursorResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::ListFolderGetLatestCursorResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::ListFolderGetLatestCursorResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#cursor-instance_method" title="#cursor (instance method)">#<strong>cursor</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="cursor-instance_method">
+
+  #<strong>cursor</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_cursor'>cursor</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cursor</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/ListFolderLongpollResult_html.html b/doc/docs/DropboxApi/Results/ListFolderLongpollResult_html.html new file mode 100644 index 00000000..f289585d --- /dev/null +++ b/doc/docs/DropboxApi/Results/ListFolderLongpollResult_html.html @@ -0,0 +1,939 @@ + + + + + + +ListFolderLongpollResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::ListFolderLongpollResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::ListFolderLongpollResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">ListFolderLongpollResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::ListFolderLongpollResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::ListFolderLongpollResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/list_folder_longpoll_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#backoff-instance_method" title="#backoff (instance method)">#<strong>backoff</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>If present, backoff for at least this many seconds before calling <code>list_folder_longpoll</code> again.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#changes-instance_method" title="#changes (instance method)">#<strong>changes</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Indicates whether new changes are available.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="backoff-instance_method">
+
+  #<strong>backoff</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>If present, backoff for at least this many seconds before calling
+ +

list_folder_longpoll again. This field is optional.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/list_folder_longpoll_result.rb', line 12</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_backoff'>backoff</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>backoff</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="changes-instance_method">
+
+  #<strong>changes</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Indicates whether new changes are available. If true, call
+ +

list_folder_continue to retrieve the changes.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

6 7 8</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/list_folder_longpoll_result.rb', line 6</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_changes'>changes</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>changes</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>true</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/ListFolderResult_html.html b/doc/docs/DropboxApi/Results/ListFolderResult_html.html new file mode 100644 index 00000000..0e3eaf55 --- /dev/null +++ b/doc/docs/DropboxApi/Results/ListFolderResult_html.html @@ -0,0 +1,1002 @@ + + + + + + +ListFolderResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::ListFolderResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::ListFolderResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">ListFolderResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::ListFolderResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::ListFolderResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/list_folder_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#cursor-instance_method" title="#cursor (instance method)">#<strong>cursor</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Pass the cursor into <code>list_folder_continue</code> to see what&#39;s changed in the folder since your previous query.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#entries-instance_method" title="#entries (instance method)">#<strong>entries</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>A collection of files and directories.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#has_more%3F-instance_method" title="#has_more? (instance method)">#<strong>has_more?</strong>  &#x21d2; Boolean </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>If true, then there are more entries available.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="cursor-instance_method">
+
+  #<strong>cursor</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Pass the cursor into <code>list_folder_continue</code> to see what&#39;s changed in the
+ +

folder since your previous query.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/list_folder_result.rb', line 13</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_cursor'>cursor</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cursor</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="entries-instance_method">
+
+  #<strong>entries</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>A collection of files and directories.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

5 6 7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/list_folder_result.rb', line 5</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_entries'>entries</span>

+ +
<span class='ivar'>@entries</span> <span class='op'>||=</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entries</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Resource.html#new-class_method" title="DropboxApi::Metadata::Resource.new (method)">new</a></span></span> <span class='id identifier rubyid_entry'>entry</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="has_more?-instance_method">
+
+  #<strong>has_more?</strong>  &#x21d2; <tt>Boolean</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>If true, then there are more entries available. Pass the cursor to
+ +

list_folder_continue to retrieve the rest.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>Boolean</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/list_folder_result.rb', line 19</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_has_more?'>has_more?</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>has_more</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>true</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/ListRevisionsResult_html.html b/doc/docs/DropboxApi/Results/ListRevisionsResult_html.html new file mode 100644 index 00000000..f5ff2a76 --- /dev/null +++ b/doc/docs/DropboxApi/Results/ListRevisionsResult_html.html @@ -0,0 +1,944 @@ + + + + + + +ListRevisionsResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::ListRevisionsResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::ListRevisionsResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">ListRevisionsResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::ListRevisionsResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::ListRevisionsResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/list_revisions_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#entries-instance_method" title="#entries (instance method)">#<strong>entries</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>A collection of files and directories.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#is_deleted%3F-instance_method" title="#is_deleted? (instance method)">#<strong>is_deleted?</strong>  &#x21d2; Boolean </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="entries-instance_method">
+
+  #<strong>entries</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>A collection of files and directories.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

5 6 7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/list_revisions_result.rb', line 5</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_entries'>entries</span>

+ +
<span class='ivar'>@entries</span> <span class='op'>||=</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entries</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span> <span class='id identifier rubyid_entry'>entry</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="is_deleted?-instance_method">
+
+  #<strong>is_deleted?</strong>  &#x21d2; <tt>Boolean</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+
+</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>Boolean</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

11 12 13</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/list_revisions_result.rb', line 11</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_is_deleted?'>is_deleted?</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>is_deleted</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='kw'>true</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/ListSharedLinksResult_html.html b/doc/docs/DropboxApi/Results/ListSharedLinksResult_html.html new file mode 100644 index 00000000..9597efbc --- /dev/null +++ b/doc/docs/DropboxApi/Results/ListSharedLinksResult_html.html @@ -0,0 +1,1002 @@ + + + + + + +ListSharedLinksResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::ListSharedLinksResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::ListSharedLinksResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (L)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">ListSharedLinksResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::ListSharedLinksResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::ListSharedLinksResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/list_shared_links_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#cursor-instance_method" title="#cursor (instance method)">#<strong>cursor</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Pass the cursor into <code>list_folder_continue</code> to see what&#39;s changed in the folder since your previous query.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#has_more%3F-instance_method" title="#has_more? (instance method)">#<strong>has_more?</strong>  &#x21d2; Boolean </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>If true, then there are more entries available.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#links-instance_method" title="#links (instance method)">#<strong>links</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Shared links applicable to the path argument.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="cursor-instance_method">
+
+  #<strong>cursor</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Pass the cursor into <code>list_folder_continue</code> to see what&#39;s changed in the
+ +

folder since your previous query.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/list_shared_links_result.rb', line 13</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_cursor'>cursor</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cursor</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="has_more?-instance_method">
+
+  #<strong>has_more?</strong>  &#x21d2; <tt>Boolean</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>If true, then there are more entries available. Pass the cursor to
+ +

list_folder_continue to retrieve the rest.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>Boolean</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/list_shared_links_result.rb', line 19</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_has_more?'>has_more?</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>has_more</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>true</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="links-instance_method">
+
+  #<strong>links</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Shared links applicable to the path argument.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

5 6 7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/list_shared_links_result.rb', line 5</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_links'>links</span>

+ +
<span class='ivar'>@entries</span> <span class='op'>||=</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>links</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">SharedLinkMetadata</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/SharedLinkMetadata.html#new-class_method" title="DropboxApi::Metadata::SharedLinkMetadata.new (method)">new</a></span></span> <span class='id identifier rubyid_entry'>entry</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/RelocationBatchResultEntry_html.html b/doc/docs/DropboxApi/Results/RelocationBatchResultEntry_html.html new file mode 100644 index 00000000..13b805b9 --- /dev/null +++ b/doc/docs/DropboxApi/Results/RelocationBatchResultEntry_html.html @@ -0,0 +1,886 @@ + + + + + + +RelocationBatchResultEntry.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::RelocationBatchResultEntry
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::RelocationBatchResultEntry";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">RelocationBatchResultEntry</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::RelocationBatchResultEntry
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::RelocationBatchResultEntry</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/relocation_batch_result_entry.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(result_data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(result_data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8 9 10 11 12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/relocation_batch_result_entry.rb', line 4</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result_data'>result_data</span><span +class='rparen'>)</span>

+ +
<span class='kw'>case</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>success</span><span class='tstring_end'>&#39;</span></span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Resource.html#new-class_method" title="DropboxApi::Metadata::Resource.new (method)">new</a></span></span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>success</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>failure</span><span class='tstring_end'>&#39;</span></span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Errors/RelocationBatchEntryError.html" title="DropboxApi::Errors::RelocationBatchEntryError (class)">RelocationBatchEntryError</a></span></span>
+    <span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>File or folder operation failed</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>failure</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown result type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/RelocationBatchResult_html.html b/doc/docs/DropboxApi/Results/RelocationBatchResult_html.html new file mode 100644 index 00000000..c42e745b --- /dev/null +++ b/doc/docs/DropboxApi/Results/RelocationBatchResult_html.html @@ -0,0 +1,903 @@ + + + + + + +RelocationBatchResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::RelocationBatchResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::RelocationBatchResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">RelocationBatchResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::RelocationBatchResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::RelocationBatchResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/relocation_batch_result.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Result returned by <span class='object_link'><a href="../Client.html#copy_batch-instance_method" title="DropboxApi::Client#copy_batch (method)">Client#copy_batch</a></span> or Client#move_batch that may
+ +

either launch an asynchronous job or complete synchronously.</p>

+ +

<p>The value will be either :in_progress or a list of +job statuses.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(result_data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(result_data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

8 9 10 11 12 13 14 15 16 17 18 19</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/relocation_batch_result.rb', line 8</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result_data'>result_data</span><span +class='rparen'>)</span>

+ +
<span class='kw'>case</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>in_progress</span><span class='tstring_end'>&#39;</span></span>
+  <span class='symbol'>:in_progress</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>complete</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>entries</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span>
+    <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="RelocationBatchResultEntry.html" title="DropboxApi::Results::RelocationBatchResultEntry (class)">RelocationBatchResultEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="RelocationBatchResultEntry.html#new-class_method" title="DropboxApi::Results::RelocationBatchResultEntry.new (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_entry'>entry</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown result type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/SaveCopyReferenceResult_html.html b/doc/docs/DropboxApi/Results/SaveCopyReferenceResult_html.html new file mode 100644 index 00000000..39e23449 --- /dev/null +++ b/doc/docs/DropboxApi/Results/SaveCopyReferenceResult_html.html @@ -0,0 +1,884 @@ + + + + + + +SaveCopyReferenceResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::SaveCopyReferenceResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::SaveCopyReferenceResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">SaveCopyReferenceResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::SaveCopyReferenceResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::SaveCopyReferenceResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/save_copy_reference_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#resource-instance_method" title="#resource (instance method)">#<strong>resource</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>The saved file or folder in the user&#39;s Dropbox.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="resource-instance_method">
+
+  #<strong>resource</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>The saved file or folder in the user&#39;s Dropbox.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

5 6 7</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/save_copy_reference_result.rb', line 5</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_resource'>resource</span>

+ +
<span class='ivar'>@resource</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Resource.html#new-class_method" title="DropboxApi::Metadata::Resource.new (method)">new</a></span></span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>metadata</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/SaveUrlJobStatus_html.html b/doc/docs/DropboxApi/Results/SaveUrlJobStatus_html.html new file mode 100644 index 00000000..36afb5c1 --- /dev/null +++ b/doc/docs/DropboxApi/Results/SaveUrlJobStatus_html.html @@ -0,0 +1,888 @@ + + + + + + +SaveUrlJobStatus.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::SaveUrlJobStatus
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::SaveUrlJobStatus";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">SaveUrlJobStatus</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::SaveUrlJobStatus
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::SaveUrlJobStatus</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/save_url_job_status.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(result_data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(result_data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8 9 10 11 12 13 14 15 16</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/save_url_job_status.rb', line 4</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result_data'>result_data</span><span +class='rparen'>)</span>

+ +
<span class='kw'>case</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>in_progress</span><span class='tstring_end'>&#39;</span></span>
+  <span class='symbol'>:in_progress</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>complete</span><span class='tstring_end'>&#39;</span></span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span> <span class='id identifier rubyid_result_data'>result_data</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>failed</span><span class='tstring_end'>&#39;</span></span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Errors/SaveUrlError.html" title="DropboxApi::Errors::SaveUrlError (class)">SaveUrlError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_build'><span class='object_link'><a href="../Errors/BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Async job failed</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+                                         <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>failed</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown result type: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/SaveUrlResult_html.html b/doc/docs/DropboxApi/Results/SaveUrlResult_html.html new file mode 100644 index 00000000..46405df2 --- /dev/null +++ b/doc/docs/DropboxApi/Results/SaveUrlResult_html.html @@ -0,0 +1,891 @@ + + + + + + +SaveUrlResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::SaveUrlResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::SaveUrlResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">SaveUrlResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::SaveUrlResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::SaveUrlResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/save_url_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#async_job_id-instance_method" title="#async_job_id (instance method)">#<strong>async_job_id</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Example with an async job:   {     &quot;.tag&quot;: &quot;async_job_id&quot;,     &quot;async_job_id&quot;: &quot;VofXAX8DO1sAAAAAAAAD_Q&quot;   }.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="async_job_id-instance_method">
+
+  #<strong>async_job_id</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Example with an async job:
+{
+  &quot;.tag&quot;: &quot;async_job_id&quot;,
+  &quot;async_job_id&quot;: &quot;VofXAX8DO1sAAAAAAAAD_Q&quot;
+}</p>
+ +

<p>I couldn&#39;t manage to get anything other than an async +job.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

11 12 13</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/save_url_result.rb', line 11</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_async_job_id'>async_job_id</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/Search/Match_html.html b/doc/docs/DropboxApi/Results/Search/Match_html.html new file mode 100644 index 00000000..4c594fe9 --- /dev/null +++ b/doc/docs/DropboxApi/Results/Search/Match_html.html @@ -0,0 +1,962 @@ + + + + + + +Match.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::Search::Match
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::Search::Match";
+relpath = '../../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../../_index.html">Index (M)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Search.html" title="DropboxApi::Results::Search (module)">Search</a></span></span>
+   &raquo; 
+  <span class="title">Match</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::Search::Match
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::Results::Search::Match</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/search/match.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(data)  &#x21d2; Match </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of Match.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#match_type-instance_method" title="#match_type (instance method)">#<strong>match_type</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#resource-instance_method" title="#resource (instance method)">#<strong>resource</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
</ul>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(data)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxApi::Results::Search::Match (class)">Match</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of Match.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/search/match.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_data'>data</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="match_type-instance_method">
+
+  #<strong>match_type</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/search/match.rb', line 8</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_match_type'>match_type</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>match_type</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="resource-instance_method">
+
+  #<strong>resource</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/search/match.rb', line 12</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_resource'>resource</span>

+ +
<span class='ivar'>@resource</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../Metadata/Resource.html#new-class_method" title="DropboxApi::Metadata::Resource.new (method)">new</a></span></span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>metadata</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/SearchResult_html.html b/doc/docs/DropboxApi/Results/SearchResult_html.html new file mode 100644 index 00000000..321955aa --- /dev/null +++ b/doc/docs/DropboxApi/Results/SearchResult_html.html @@ -0,0 +1,1002 @@ + + + + + + +SearchResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::SearchResult
+
+  &mdash; Documentation by YARD 0.9.19
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+ +

<script type=“text/javascript” charset=“utf-8”>

+ +
pathId = "DropboxApi::Results::SearchResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">SearchResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::SearchResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::SearchResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/search_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#has_more%3F-instance_method" title="#has_more? (instance method)">#<strong>has_more?</strong>  &#x21d2; Boolean </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Used for paging.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#matches-instance_method" title="#matches (instance method)">#<strong>matches</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>A list (possibly empty) of matches for the query.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#start-instance_method" title="#start (instance method)">#<strong>start</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Used for paging.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="has_more?-instance_method">
+
+  #<strong>has_more?</strong>  &#x21d2; <tt>Boolean</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Used for paging. If true, indicates there is another page of results
+ +

available that can be fetched by calling search again.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>Boolean</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

18 19 20</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/search_result.rb', line 18</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_has_more?'>has_more?</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>more</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>true</span><span class='tstring_end'>&quot;</span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="matches-instance_method">
+
+  #<strong>matches</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>A list (possibly empty) of matches for the query.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/search_result.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_matches'>matches</span>

+ +
<span class='ivar'>@matches</span> <span class='op'>||=</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>matches</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_match'>match</span><span class='op'>|</span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Search.html" title="DropboxApi::Results::Search (module)">Search</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Search/Match.html" title="DropboxApi::Results::Search::Match (class)">Match</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Search/Match.html#initialize-instance_method" title="DropboxApi::Results::Search::Match#initialize (method)">new</a></span></span> <span class='id identifier rubyid_match'>match</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="start-instance_method">
+
+  #<strong>start</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Used for paging. Value to set the start argument to when calling search
+ +

to fetch the next page of results.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/search_result.rb', line 12</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_start'>start</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>start</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Fri May 31 17:53:34 2019 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.19 (ruby-2.6.2).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/SearchV2Result_html.html b/doc/docs/DropboxApi/Results/SearchV2Result_html.html new file mode 100644 index 00000000..d2fedd89 --- /dev/null +++ b/doc/docs/DropboxApi/Results/SearchV2Result_html.html @@ -0,0 +1,1002 @@ + + + + + + +SearchV2Result.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::SearchV2Result
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::SearchV2Result";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">SearchV2Result</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::SearchV2Result
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::SearchV2Result</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/search_v2_result.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#cursor-instance_method" title="#cursor (instance method)">#<strong>cursor</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Pass the cursor into #search_continue to fetch the next page of results.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#has_more%3F-instance_method" title="#has_more? (instance method)">#<strong>has_more?</strong>  &#x21d2; Boolean </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>Used for paging.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#matches-instance_method" title="#matches (instance method)">#<strong>matches</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>A list (possibly empty) of matches for the query.</p>
+ +

</div></span>

+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="cursor-instance_method">
+
+  #<strong>cursor</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Pass the cursor into #search_continue to fetch the next page of results.
+ +

This field is optional.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

19 20 21</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/search_v2_result.rb', line 19</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_cursor'>cursor</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cursor</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="has_more?-instance_method">
+
+  #<strong>has_more?</strong>  &#x21d2; <tt>Boolean</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Used for paging. If true, indicates there is another page of results
+ +

available that can be fetched by calling search again.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

<p class=“tag_title”>Returns:</p> <ul class=“return”>

+ +
<li>
+
+    <span class='type'>(<tt>Boolean</tt>)</span>
+
+</li>
+ +

</ul>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

13 14 15</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/search_v2_result.rb', line 13</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_has_more?'>has_more?</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>has_more</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>true</span><span class='tstring_end'>&#39;</span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="matches-instance_method">
+
+  #<strong>matches</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>A list (possibly empty) of matches for the query.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

5 6 7 8 9</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/search_v2_result.rb', line 5</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_matches'>matches</span>

+ +
<span class='ivar'>@matches</span> <span class='op'>||=</span> <span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>matches</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_match'>match</span><span class='op'>|</span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/SearchMatchV2.html" title="DropboxApi::Metadata::SearchMatchV2 (class)">SearchMatchV2</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span> <span class='id identifier rubyid_match'>match</span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/Search_html.html b/doc/docs/DropboxApi/Results/Search_html.html new file mode 100644 index 00000000..c3909384 --- /dev/null +++ b/doc/docs/DropboxApi/Results/Search_html.html @@ -0,0 +1,796 @@ + + + + + + +Search.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Module: DropboxApi::Results::Search
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::Search";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">Search</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Module: DropboxApi::Results::Search
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/search/match.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Defined Under Namespace</h2> <p class=“children”>

+ +
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Search/Match.html" title="DropboxApi::Results::Search::Match (class)">Match</a></span>
+ +

</p>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/ShareFolderLaunch_html.html b/doc/docs/DropboxApi/Results/ShareFolderLaunch_html.html new file mode 100644 index 00000000..1032c321 --- /dev/null +++ b/doc/docs/DropboxApi/Results/ShareFolderLaunch_html.html @@ -0,0 +1,872 @@ + + + + + + +ShareFolderLaunch.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::ShareFolderLaunch
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::ShareFolderLaunch";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">ShareFolderLaunch</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::ShareFolderLaunch
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxApi::Results::ShareFolderLaunch</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/share_folder_launch.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#new-class_method" title="new (class method)">.<strong>new</strong>(result_data)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="new-class_method">
+
+  .<strong>new</strong>(result_data)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6 7 8 9 10 11 12 13</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/share_folder_launch.rb', line 4</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_new'>new</span><span +class='lparen'>(</span><span class='id identifier +rubyid_result_data'>result_data</span><span +class='rparen'>)</span>

+ +
<span class='kw'>case</span> <span class='id identifier rubyid_result_data'>result_data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.tag</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>complete</span><span class='tstring_end'>&#39;</span></span>
+  <span class='const'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Metadata/SharedFolder.html" title="DropboxApi::Metadata::SharedFolder (class)">SharedFolder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span> <span class='id identifier rubyid_result_data'>result_data</span>
+<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>&#39;</span></span>
+  <span class='id identifier rubyid_result_data'>result_data</span>
+<span class='kw'>else</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unable to infer resource type for `</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_tag'>tag</span><span class='embexpr_end'>}</span><span class='tstring_content'>`</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/SharedFileMembers_html.html b/doc/docs/DropboxApi/Results/SharedFileMembers_html.html new file mode 100644 index 00000000..59e6155e --- /dev/null +++ b/doc/docs/DropboxApi/Results/SharedFileMembers_html.html @@ -0,0 +1,993 @@ + + + + + + +SharedFileMembers.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::SharedFileMembers
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::SharedFileMembers";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">SharedFileMembers</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::SharedFileMembers
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::SharedFileMembers</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/shared_file_members.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#cursor-instance_method" title="#cursor (instance method)">#<strong>cursor</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#groups-instance_method" title="#groups (instance method)">#<strong>groups</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#invitees-instance_method" title="#invitees (instance method)">#<strong>invitees</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#users-instance_method" title="#users (instance method)">#<strong>users</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="cursor-instance_method">
+
+  #<strong>cursor</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/shared_file_members.rb', line 16</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_cursor'>cursor</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cursor</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="groups-instance_method">
+
+  #<strong>groups</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/shared_file_members.rb', line 8</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_groups'>groups</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>groups</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="invitees-instance_method">
+
+  #<strong>invitees</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/shared_file_members.rb', line 12</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_invitees'>invitees</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invitees</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="users-instance_method">
+
+  #<strong>users</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/shared_file_members.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_users'>users</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>users</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/SharedFolderMembers_html.html b/doc/docs/DropboxApi/Results/SharedFolderMembers_html.html new file mode 100644 index 00000000..7946600f --- /dev/null +++ b/doc/docs/DropboxApi/Results/SharedFolderMembers_html.html @@ -0,0 +1,993 @@ + + + + + + +SharedFolderMembers.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::SharedFolderMembers
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::SharedFolderMembers";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (S)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">SharedFolderMembers</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::SharedFolderMembers
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::SharedFolderMembers</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/shared_folder_members.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#cursor-instance_method" title="#cursor (instance method)">#<strong>cursor</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#groups-instance_method" title="#groups (instance method)">#<strong>groups</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#invitees-instance_method" title="#invitees (instance method)">#<strong>invitees</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#users-instance_method" title="#users (instance method)">#<strong>users</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="cursor-instance_method">
+
+  #<strong>cursor</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

16 17 18</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/shared_folder_members.rb', line 16</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_cursor'>cursor</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cursor</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="groups-instance_method">
+
+  #<strong>groups</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

8 9 10</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/shared_folder_members.rb', line 8</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_groups'>groups</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>groups</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="invitees-instance_method">
+
+  #<strong>invitees</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

12 13 14</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/shared_folder_members.rb', line 12</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_invitees'>invitees</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invitees</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="users-instance_method">
+
+  #<strong>users</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/shared_folder_members.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_users'>users</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>users</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:27 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/UploadSessionStart_html.html b/doc/docs/DropboxApi/Results/UploadSessionStart_html.html new file mode 100644 index 00000000..f00c984a --- /dev/null +++ b/doc/docs/DropboxApi/Results/UploadSessionStart_html.html @@ -0,0 +1,873 @@ + + + + + + +UploadSessionStart.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::UploadSessionStart
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::UploadSessionStart";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (U)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">UploadSessionStart</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::UploadSessionStart
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::UploadSessionStart</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/upload_session_start.rb</dd>
+</dl>
+ +

</div>

+ +
  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#session_id-instance_method" title="#session_id (instance method)">#<strong>session_id</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +
<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="session_id-instance_method">
+
+  #<strong>session_id</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

4 5 6</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'lib/dropbox_api/results/upload_session_start.rb', line 4</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_session_id'>session_id</span>

+ +
<span class='ivar'>@data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>session_id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:26 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results/VoidResult_html.html b/doc/docs/DropboxApi/Results/VoidResult_html.html new file mode 100644 index 00000000..d9a1b697 --- /dev/null +++ b/doc/docs/DropboxApi/Results/VoidResult_html.html @@ -0,0 +1,821 @@ + + + + + + +VoidResult.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxApi::Results::VoidResult
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results::VoidResult";
+relpath = '../../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../../_index.html">Index (V)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Results.html" title="DropboxApi::Results (module)">Results</a></span></span>
+   &raquo; 
+  <span class="title">VoidResult</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxApi::Results::VoidResult
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next"><span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></li>
+
+          <li class="next">DropboxApi::Results::VoidResult</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/void_result.rb</dd>
+</dl>
+ +

</div>

+ +
<h2>Method Summary</h2>
+
+<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Results::Base (class)">Base</a></span></h3>
+<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span></p>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">DropboxApi::Results::Base</a></span></p>
+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:25 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi/Results_html.html b/doc/docs/DropboxApi/Results_html.html new file mode 100644 index 00000000..6075748e --- /dev/null +++ b/doc/docs/DropboxApi/Results_html.html @@ -0,0 +1,802 @@ + + + + + + +Results.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Module: DropboxApi::Results
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="../css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi::Results";
+relpath = '../';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="../class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="../_index.html">Index (R)</a> &raquo;
+  <span class='title'><span class='object_link'><a href="../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span>
+   &raquo; 
+  <span class="title">Results</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="../class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Module: DropboxApi::Results
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/results/base.rb<span class="defines">,<br />
+lib/dropbox_api/results/void_result.rb,<br /> lib/dropbox_api/results/save_url_result.rb,<br /> lib/dropbox_api/results/search_v2_result.rb,<br /> lib/dropbox_api/results/copy_batch_result.rb,<br /> lib/dropbox_api/results/list_folder_result.rb,<br /> lib/dropbox_api/results/basic_account_batch.rb,<br /> lib/dropbox_api/results/delete_batch_result.rb,<br /> lib/dropbox_api/results/save_url_job_status.rb,<br /> lib/dropbox_api/results/share_folder_launch.rb,<br /> lib/dropbox_api/results/shared_file_members.rb,<br /> lib/dropbox_api/results/upload_session_start.rb,<br /> lib/dropbox_api/results/list_revisions_result.rb,<br /> lib/dropbox_api/results/shared_folder_members.rb,<br /> lib/dropbox_api/results/relocation_batch_result.rb,<br /> lib/dropbox_api/results/list_shared_links_result.rb,<br /> lib/dropbox_api/results/delete_batch_result_entry.rb,<br /> lib/dropbox_api/results/get_copy_reference_result.rb,<br /> lib/dropbox_api/results/get_temporary_link_result.rb,<br /> lib/dropbox_api/results/create_folder_batch_result.rb,<br /> lib/dropbox_api/results/get_thumbnail_batch_result.rb,<br /> lib/dropbox_api/results/save_copy_reference_result.rb,<br /> lib/dropbox_api/results/add_file_member_result_list.rb,<br /> lib/dropbox_api/results/list_folder_longpoll_result.rb,<br /> lib/dropbox_api/results/relocation_batch_result_entry.rb,<br /> lib/dropbox_api/results/create_folder_batch_result_entry.rb,<br /> lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb</span>
+ +

</dd>

+ +
</dl>
+ +

</div>

+ +

<h2>Defined Under Namespace</h2> <p class=“children”>

+ +
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Results/Search.html" title="DropboxApi::Results::Search (module)">Search</a></span>
+
+<strong class="classes">Classes:</strong> <span class='object_link'><a href="Results/AddFileMemberResultList.html" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</a></span>, <span class='object_link'><a href="Results/Base.html" title="DropboxApi::Results::Base (class)">Base</a></span>, <span class='object_link'><a href="Results/BasicAccountBatch.html" title="DropboxApi::Results::BasicAccountBatch (class)">BasicAccountBatch</a></span>, <span class='object_link'><a href="Results/CopyBatchResult.html" title="DropboxApi::Results::CopyBatchResult (class)">CopyBatchResult</a></span>, <span class='object_link'><a href="Results/CreateFolderBatchResult.html" title="DropboxApi::Results::CreateFolderBatchResult (class)">CreateFolderBatchResult</a></span>, <span class='object_link'><a href="Results/CreateFolderBatchResultEntry.html" title="DropboxApi::Results::CreateFolderBatchResultEntry (class)">CreateFolderBatchResultEntry</a></span>, <span class='object_link'><a href="Results/DeleteBatchResult.html" title="DropboxApi::Results::DeleteBatchResult (class)">DeleteBatchResult</a></span>, <span class='object_link'><a href="Results/DeleteBatchResultEntry.html" title="DropboxApi::Results::DeleteBatchResultEntry (class)">DeleteBatchResultEntry</a></span>, <span class='object_link'><a href="Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">GetCopyReferenceResult</a></span>, <span class='object_link'><a href="Results/GetTemporaryLinkResult.html" title="DropboxApi::Results::GetTemporaryLinkResult (class)">GetTemporaryLinkResult</a></span>, <span class='object_link'><a href="Results/GetThumbnailBatchResult.html" title="DropboxApi::Results::GetThumbnailBatchResult (class)">GetThumbnailBatchResult</a></span>, <span class='object_link'><a href="Results/ListFolderGetLatestCursorResult.html" title="DropboxApi::Results::ListFolderGetLatestCursorResult (class)">ListFolderGetLatestCursorResult</a></span>, <span class='object_link'><a href="Results/ListFolderLongpollResult.html" title="DropboxApi::Results::ListFolderLongpollResult (class)">ListFolderLongpollResult</a></span>, <span class='object_link'><a href="Results/ListFolderResult.html" title="DropboxApi::Results::ListFolderResult (class)">ListFolderResult</a></span>, <span class='object_link'><a href="Results/ListRevisionsResult.html" title="DropboxApi::Results::ListRevisionsResult (class)">ListRevisionsResult</a></span>, <span class='object_link'><a href="Results/ListSharedLinksResult.html" title="DropboxApi::Results::ListSharedLinksResult (class)">ListSharedLinksResult</a></span>, <span class='object_link'><a href="Results/RelocationBatchResult.html" title="DropboxApi::Results::RelocationBatchResult (class)">RelocationBatchResult</a></span>, <span class='object_link'><a href="Results/RelocationBatchResultEntry.html" title="DropboxApi::Results::RelocationBatchResultEntry (class)">RelocationBatchResultEntry</a></span>, <span class='object_link'><a href="Results/SaveCopyReferenceResult.html" title="DropboxApi::Results::SaveCopyReferenceResult (class)">SaveCopyReferenceResult</a></span>, <span class='object_link'><a href="Results/SaveUrlJobStatus.html" title="DropboxApi::Results::SaveUrlJobStatus (class)">SaveUrlJobStatus</a></span>, <span class='object_link'><a href="Results/SaveUrlResult.html" title="DropboxApi::Results::SaveUrlResult (class)">SaveUrlResult</a></span>, <span class='object_link'><a href="Results/SearchV2Result.html" title="DropboxApi::Results::SearchV2Result (class)">SearchV2Result</a></span>, <span class='object_link'><a href="Results/ShareFolderLaunch.html" title="DropboxApi::Results::ShareFolderLaunch (class)">ShareFolderLaunch</a></span>, <span class='object_link'><a href="Results/SharedFileMembers.html" title="DropboxApi::Results::SharedFileMembers (class)">SharedFileMembers</a></span>, <span class='object_link'><a href="Results/SharedFolderMembers.html" title="DropboxApi::Results::SharedFolderMembers (class)">SharedFolderMembers</a></span>, <span class='object_link'><a href="Results/UploadSessionStart.html" title="DropboxApi::Results::UploadSessionStart (class)">UploadSessionStart</a></span>, <span class='object_link'><a href="Results/VoidResult.html" title="DropboxApi::Results::VoidResult (class)">VoidResult</a></span>
+ +

</p>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxApi_html.html b/doc/docs/DropboxApi_html.html new file mode 100644 index 00000000..884480bb --- /dev/null +++ b/doc/docs/DropboxApi_html.html @@ -0,0 +1,815 @@ + + + + + + +DropboxApi.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Module: DropboxApi
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxApi";
+relpath = '';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="_index.html">Index (D)</a> &raquo;
+
+  <span class="title">DropboxApi</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Module: DropboxApi
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Defined in:</dt>
+  <dd>lib/dropbox_api/client.rb<span class="defines">,<br />
+lib/dropbox_api/version.rb,<br /> lib/dropbox_api/authenticator.rb,<br /> lib/dropbox_api/result_builder.rb,<br /> lib/dropbox_api/chunked_uploader.rb,<br /> lib/dropbox_api/errors/http_error.rb,<br /> lib/dropbox_api/options_validator.rb,<br /> lib/dropbox_api/connection_builder.rb,<br /> lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb</span>
+ +

</dd>

+ +
</dl>
+ +

</div>

+ +

<h2>Defined Under Namespace</h2> <p class=“children”>

+ +
<strong class="modules">Modules:</strong> <span class='object_link'><a href="DropboxApi/Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span>, <span class='object_link'><a href="DropboxApi/Errors.html" title="DropboxApi::Errors (module)">Errors</a></span>, <span class='object_link'><a href="DropboxApi/Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span>, <span class='object_link'><a href="DropboxApi/MiddleWare.html" title="DropboxApi::MiddleWare (module)">MiddleWare</a></span>, <span class='object_link'><a href="DropboxApi/OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span>, <span class='object_link'><a href="DropboxApi/Results.html" title="DropboxApi::Results (module)">Results</a></span>
+
+<strong class="classes">Classes:</strong> <span class='object_link'><a href="DropboxApi/Authenticator.html" title="DropboxApi::Authenticator (class)">Authenticator</a></span>, <span class='object_link'><a href="DropboxApi/ChunkedUploader.html" title="DropboxApi::ChunkedUploader (class)">ChunkedUploader</a></span>, <span class='object_link'><a href="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span>, <span class='object_link'><a href="DropboxApi/ConnectionBuilder.html" title="DropboxApi::ConnectionBuilder (class)">ConnectionBuilder</a></span>, <span class='object_link'><a href="DropboxApi/ResultBuilder.html" title="DropboxApi::ResultBuilder (class)">ResultBuilder</a></span>
+ +

</p>

+ +
<h2>
+  Constant Summary
+  <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+</h2>
+
+<dl class="constants">
+
+    <dt id="VERSION-constant" class="">VERSION =
+
+    </dt>
+    <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.1.20</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+</dl>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/DropboxScaffoldBuilder_html.html b/doc/docs/DropboxScaffoldBuilder_html.html new file mode 100644 index 00000000..898bb50c --- /dev/null +++ b/doc/docs/DropboxScaffoldBuilder_html.html @@ -0,0 +1,1731 @@ + + + + + + +DropboxScaffoldBuilder.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Class: DropboxScaffoldBuilder
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "DropboxScaffoldBuilder";
+relpath = '';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="_index.html">Index (D)</a> &raquo;
+
+  <span class="title">DropboxScaffoldBuilder</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Class: DropboxScaffoldBuilder
+ +

</h1> <div class=“box_info”>

+ +
<dl>
+  <dt>Inherits:</dt>
+  <dd>
+    <span class="inheritName">Object</span>
+
+      <ul class="fullTree">
+        <li>Object</li>
+
+          <li class="next">DropboxScaffoldBuilder</li>
+
+      </ul>
+      <a href="#" class="inheritanceTree">show all</a>
+
+  </dd>
+</dl>
+
+<dl>
+  <dt>Defined in:</dt>
+  <dd>spec/support/dropbox_scaffold_builder.rb</dd>
+</dl>
+ +

</div>

+ +

<h2>Overview</h2><div class=“docstring”>

+ +
<div class="discussion">
+  <p>This class is useful to set up an existing Dropbox account in a state which
+ +

is ready to pass the tests.</p>

+ +

<p>For example, on the tests for the delete endpoint you +may be deleting the file at /delete/file.txt, so we need to +upload a file at that location or the test won&#39;t pass. +That&#39;s exactly what delete is expected to do.</p>

+ +

<p>Other endpoints&#39; tests will have different requirements +and this class is to provide an automated way to fulfill these. For each +endpoint we need to test, you may have a method here that sets up +everything that the tests for that endpoint needs.</p>

+ +

<p>Note that, paradoxically, the methods here use the same methods we +want to test. This shouldn&#39;t be a problem as the purpose of this is +to allow us to regenerate the VCR cassettes, so if this automated mechanism +fails you can always do the job manually and record the VCR cassette +without using this.</p>

+ +

<p>The Dropbox server may introduce minor changes over time so +it&#39;s good to regenerate the cassettes every now and then, but we +don&#39;t need to do it in every execution of the test suite.</p>

+ +
</div>
+ +

</div> <div class=“tags”>

+ +

</div>

+ +
  <h2>
+    Constant Summary
+    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+  </h2>
+
+  <dl class="constants">
+
+      <dt id="PREFIX-constant" class="">PREFIX =
+
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/dropbox_api_fixtures</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+  </dl>
+
+  <h2>
+    Class Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#fixtures_path-class_method" title="fixtures_path (class method)">.<strong>fixtures_path</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#prefix_for-class_method" title="prefix_for (class method)">.<strong>prefix_for</strong>(endpoint_name)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#regenerate-class_method" title="regenerate (class method)">.<strong>regenerate</strong>(endpoint_name)  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#regenerate_all-class_method" title="regenerate_all (class method)">.<strong>regenerate_all</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
  </ul>
+
+  <h2>
+    Instance Method Summary
+    <small><a href="#" class="summary_toggle">collapse</a></small>
+  </h2>
+
+  <ul class="summary">
+
+      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_copy_batch-instance_method" title="#build_copy_batch (instance method)">#<strong>build_copy_batch</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_create_file_request-instance_method" title="#build_create_file_request (instance method)">#<strong>build_create_file_request</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_delete-instance_method" title="#build_delete (instance method)">#<strong>build_delete</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_get_metadata-instance_method" title="#build_get_metadata (instance method)">#<strong>build_get_metadata</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_get_shared_link_metadata-instance_method" title="#build_get_shared_link_metadata (instance method)">#<strong>build_get_shared_link_metadata</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_get_thumbnail_batch-instance_method" title="#build_get_thumbnail_batch (instance method)">#<strong>build_get_thumbnail_batch</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_list_folder-instance_method" title="#build_list_folder (instance method)">#<strong>build_list_folder</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_search-instance_method" title="#build_search (instance method)">#<strong>build_search</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_upload-instance_method" title="#build_upload (instance method)">#<strong>build_upload</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#build_upload_by_chunks-instance_method" title="#build_upload_by_chunks (instance method)">#<strong>build_upload_by_chunks</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#clobber-instance_method" title="#clobber (instance method)">#<strong>clobber</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#generate-instance_method" title="#generate (instance method)">#<strong>generate</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'></div></span>
+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(endpoint_name)  &#x21d2; DropboxScaffoldBuilder </a>
+
+</span>
+
+  <span class="note title constructor">constructor</span>
+
+  <span class="summary_desc"><div class='inline'><p>A new instance of DropboxScaffoldBuilder.</p>
+ +

</div></span>

+ +

</li>

+ +
      <li class="public ">
+<span class="summary_signature">
+
+    <a href="#path_prefix-instance_method" title="#path_prefix (instance method)">#<strong>path_prefix</strong>  &#x21d2; Object </a>
+
+</span>
+
+  <span class="summary_desc"><div class='inline'><p>We have a prefix for each endpoint to avoid conflicts across them.</p>
+ +

</div></span>

+ +

</li>

+ +
</ul>
+ +

<div id=“constructor_details” class=“method_details_list”>

+ +
<h2>Constructor Details</h2>
+
+  <div class="method_details first">
+<h3 class="signature first" id="initialize-instance_method">
+
+  #<strong>initialize</strong>(endpoint_name)  &#x21d2; <tt><span class='object_link'><a href="" title="DropboxScaffoldBuilder (class)">DropboxScaffoldBuilder</a></span></tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>Returns a new instance of DropboxScaffoldBuilder.</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

47 48 49</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 47</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_initialize'>initialize</span><span +class='lparen'>(</span><span class='id identifier +rubyid_endpoint_name'>endpoint_name</span><span +class='rparen'>)</span>

+ +
<span class='ivar'>@endpoint_name</span> <span class='op'>=</span> <span class='id identifier rubyid_endpoint_name'>endpoint_name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +

</div>

+ +
<div id="class_method_details" class="method_details_list">
+  <h2>Class Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="fixtures_path-class_method">
+
+  .<strong>fixtures_path</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

41 42 43</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 41</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_fixtures_path'>fixtures_path</span>

+ +
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>../../fixtures</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>__FILE__</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="prefix_for-class_method">
+
+  .<strong>prefix_for</strong>(endpoint_name)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

37 38 39</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 37</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_prefix_for'>prefix_for</span><span +class='lparen'>(</span><span class='id identifier +rubyid_endpoint_name'>endpoint_name</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_name'>endpoint_name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_path_prefix'>path_prefix</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="regenerate-class_method">
+
+  .<strong>regenerate</strong>(endpoint_name)  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

31 32 33 34 35</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 31</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_regenerate'>regenerate</span><span +class='lparen'>(</span><span class='id identifier +rubyid_endpoint_name'>endpoint_name</span><span +class='rparen'>)</span>

+ +
<span class='id identifier rubyid_builder'>builder</span> <span class='op'>=</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_endpoint_name'>endpoint_name</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_clobber'>clobber</span>
+<span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_generate'>generate</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="regenerate_all-class_method">
+
+  .<strong>regenerate_all</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

24 25 26 27 28 29</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 24</span>
+ +

<span class='kw'>def</span> <span +class='kw'>self</span><span +class='period'>.</span><span class='id identifier +rubyid_regenerate_all'>regenerate_all</span>

+ +
<span class='id identifier rubyid_public_instance_methods'>public_instance_methods</span>
+  <span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:to_s</span><span class='rparen'>)</span>
+  <span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_method_name'>method_name</span><span class='op'>|</span> <span class='id identifier rubyid_method_name'>method_name</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>build</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='rbrace'>}</span>
+  <span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_method_name'>method_name</span><span class='op'>|</span> <span class='id identifier rubyid_regenerate'>regenerate</span><span class='lparen'>(</span><span class='id identifier rubyid_method_name'>method_name</span><span class='period'>.</span><span class='id identifier rubyid_sub'>sub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>build_</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+
+<div id="instance_method_details" class="method_details_list">
+  <h2>Instance Method Details</h2>
+
+    <div class="method_details first">
+<h3 class="signature first" id="build_copy_batch-instance_method">
+
+  #<strong>build_copy_batch</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

65 66 67 68</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 65</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_copy_batch'>build_copy_batch</span>

+ +
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Che primo! aon vas?</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_2.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Pal Calvari, amic</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_create_file_request-instance_method">
+
+  #<strong>build_create_file_request</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

70 71 72</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 70</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_build_create_file_request'>build_create_file_request</span>

+ +
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Arkansas, dude.</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_delete-instance_method">
+
+  #<strong>build_delete</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

74 75 76 77 78 79 80 81</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 74</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_delete'>build_delete</span>

+ +
<span class='id identifier rubyid_file_contents'>file_contents</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Tijuana, amigo.</span><span class='tstring_end'>&#39;</span></span>
+
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/will_be_deleted.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_file_contents'>file_contents</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/wont_be_deleted.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_file_contents'>file_contents</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/folder/a.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_file_contents'>file_contents</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/folder/b.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_file_contents'>file_contents</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_get_metadata-instance_method">
+
+  #<strong>build_get_metadata</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

83 84 85 86 87 88 89 90</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 83</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_build_get_metadata'>build_get_metadata</span>

+ +
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/file.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>This is a test file.</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span>
+  <span class='label'>client_modified:</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='int'>1988</span><span class='comma'>,</span> <span class='int'>12</span><span class='comma'>,</span> <span class='int'>8</span><span class='comma'>,</span> <span class='int'>1</span><span class='comma'>,</span> <span class='int'>1</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>+00:00</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='rbrace'>}</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder'>create_folder</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/deleted_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>This is a test file.</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/deleted_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_get_shared_link_metadata-instance_method">
+
+  #<strong>build_get_shared_link_metadata</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

111 112 113 114 115 116 117</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 111</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_build_get_shared_link_metadata'>build_get_shared_link_metadata</span>

+ +
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder'>create_folder</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>I shall be shared.</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_get_thumbnail_batch-instance_method">
+
+  #<strong>build_get_thumbnail_batch</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

106 107 108 109</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 106</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_build_get_thumbnail_batch'>build_get_thumbnail_batch</span>

+ +
<span class='id identifier rubyid_file_content'>file_content</span> <span class='op'>=</span> <span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_fixtures_path'>fixtures_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>img.png</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/img.png</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_file_content'>file_content</span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_list_folder-instance_method">
+
+  #<strong>build_list_folder</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

92 93 94 95 96</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 92</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_list_folder'>build_list_folder</span>

+ +
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder'>create_folder</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_shared_link_with_settings'>create_shared_link_with_settings</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder/cow.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Moo.</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_search-instance_method">
+
+  #<strong>build_search</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

119 120 121</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 119</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_search'>build_search</span>

+ +
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload'>upload</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/findable_file.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Moo.</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_upload-instance_method">
+
+  #<strong>build_upload</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

98 99 100</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 98</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_build_upload'>build_upload</span>

+ +
<span class='comment'># No need to set up anything
+ +

</span><span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="build_upload_by_chunks-instance_method">
+
+  #<strong>build_upload_by_chunks</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

102 103 104</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 102</span>
+ +

<span class='kw'>def</span> <span class='id +identifier +rubyid_build_upload_by_chunks'>build_upload_by_chunks</span>

+ +
<span class='comment'># No op
+ +

</span><span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="client-instance_method">
+
+  #<strong>client</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

61 62 63</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 61</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_client'>client</span>

+ +
<span class='ivar'>@client</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">new</a></span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="clobber-instance_method">
+
+  #<strong>clobber</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

51 52 53 54 55</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 51</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_clobber'>clobber</span>

+ +
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='id identifier rubyid_path_prefix'>path_prefix</span>
+ +

<span class='kw'>rescue</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Errors.html” title=“DropboxApi::Errors +(module)”>Errors</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Errors/NotFoundError.html” +title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span></span>

+ +
<span class='kw'>false</span> <span class='comment'># It&#39;s ok if it doesn&#39;t exist
+ +

</span><span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="generate-instance_method">
+
+  #<strong>generate</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

57 58 59</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 57</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_generate'>generate</span>

+ +
<span class='id identifier rubyid_send'>send</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>build_</span><span class='embexpr_beg'>#{</span><span class='ivar'>@endpoint_name</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
    <div class="method_details ">
+<h3 class="signature " id="path_prefix-instance_method">
+
+  #<strong>path_prefix</strong>  &#x21d2; <tt>Object</tt>
+ +

</h3><div class=“docstring”>

+ +
<div class="discussion">
+  <p>We have a prefix for each endpoint to avoid conflicts across them</p>
+
+</div>
+ +

</div> <div class=“tags”>

+ +

</div> <table class=“source_code”>

+ +
<tr>
+  <td>
+    <pre class="lines">
+ +

124 125 126</pre>

+ +
</td>
+<td>
+  <pre class="code"><span class="info file"># File 'spec/support/dropbox_scaffold_builder.rb', line 124</span>
+ +

<span class='kw'>def</span> <span class='id +identifier rubyid_path_prefix'>path_prefix</span>

+ +
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span> <span class='const'><span class='object_link'><a href="#PREFIX-constant" title="DropboxScaffoldBuilder::PREFIX (constant)">PREFIX</a></span></span><span class='comma'>,</span> <span class='ivar'>@endpoint_name</span>
+ +

<span class='kw'>end</span></pre>

+ +
  </td>
+</tr>
+ +

</table> </div>

+ +
</div>
+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:28 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/_index_html.html b/doc/docs/_index_html.html new file mode 100644 index 00000000..f4551c4e --- /dev/null +++ b/doc/docs/_index_html.html @@ -0,0 +1,2911 @@ + + + + + + +_index.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = null;
+relpath = '';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.26</h1>
+ +

<div id=“listing”>

+ +
<h1 class="alphaindex">Alphabetic Index</h1>
+
+<h2>File Listing</h2>
+<ul id="files" class="index_inline_list">
+
+  <li class="r1"><a href="index.html" title="README">README</a></li>
+
+  <li class="r2"><a href="file.api_coverage.html" title="API Implementation Coverage">API Implementation Coverage</a></li>
+
+  <li class="r1"><a href="file.rails_setup.html" title="Rails setup">Rails setup</a></li>
+
+</ul>
+ +

<div class=“clear”></div> <h2>Namespace Listing +A-Z</h2>

+ +

<table>

+ +
<tr>
+  <td valign='top' width="33%">
+
+      <ul id="alpha_A" class="alpha">
+        <li class="letter">A</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/AccessLevel.html" title="DropboxApi::Metadata::AccessLevel (class)">AccessLevel</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/AddFileMember.html" title="DropboxApi::Endpoints::Sharing::AddFileMember (class)">AddFileMember</a></span>
+
+                <small>(DropboxApi::Endpoints::Sharing)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/AddFileMemberError.html" title="DropboxApi::Errors::AddFileMemberError (class)">AddFileMemberError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/AddFileMemberResult.html" title="DropboxApi::Metadata::AddFileMemberResult (class)">AddFileMemberResult</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/AddFileMemberResultList.html" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/AddFolderMember.html" title="DropboxApi::Endpoints::Sharing::AddFolderMember (class)">AddFolderMember</a></span>
+
+                <small>(DropboxApi::Endpoints::Sharing)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/AddFolderMemberError.html" title="DropboxApi::Errors::AddFolderMemberError (class)">AddFolderMemberError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/AddMember.html" title="DropboxApi::Metadata::AddMember (class)">AddMember</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/AddMemberSelectorError.html" title="DropboxApi::Errors::AddMemberSelectorError (class)">AddMemberSelectorError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/AlreadySharedError.html" title="DropboxApi::Errors::AlreadySharedError (class)">AlreadySharedError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Auth.html" title="DropboxApi::Endpoints::Auth (module)">Auth</a></span>
+
+                <small>(DropboxApi::Endpoints)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Authenticator.html" title="DropboxApi::Authenticator (class)">Authenticator</a></span>
+
+                <small>(DropboxApi)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_B" class="alpha">
+        <li class="letter">B</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/BadPathError.html" title="DropboxApi::Errors::BadPathError (class)">BadPathError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span>
+
+                <small>(DropboxApi::Endpoints)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/Base.html" title="DropboxApi::Results::Base (class)">Base</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/BasicAccount.html" title="DropboxApi::Metadata::BasicAccount (class)">BasicAccount</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/BasicAccountBatch.html" title="DropboxApi::Results::BasicAccountBatch (class)">BasicAccountBatch</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/BasicError.html" title="DropboxApi::Errors::BasicError (class)">BasicError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_C" class="alpha">
+        <li class="letter">C</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/CantCopySharedFolderError.html" title="DropboxApi::Errors::CantCopySharedFolderError (class)">CantCopySharedFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/CantMoveFolderIntoItselfError.html" title="DropboxApi::Errors::CantMoveFolderIntoItselfError (class)">CantMoveFolderIntoItselfError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/CantNestSharedFolderError.html" title="DropboxApi::Errors::CantNestSharedFolderError (class)">CantNestSharedFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/CantShareOutsideTeamError.html" title="DropboxApi::Errors::CantShareOutsideTeamError (class)">CantShareOutsideTeamError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/ChunkedUploader.html" title="DropboxApi::ChunkedUploader (class)">ChunkedUploader</a></span>
+
+                <small>(DropboxApi)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Client.html" title="DropboxApi::Client (class)">Client</a></span>
+
+                <small>(DropboxApi)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/CommitInfo.html" title="DropboxApi::Metadata::CommitInfo (class)">CommitInfo</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/ConnectionBuilder.html" title="DropboxApi::ConnectionBuilder (class)">ConnectionBuilder</a></span>
+
+                <small>(DropboxApi)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/ContainsSharedFolderError.html" title="DropboxApi::Errors::ContainsSharedFolderError (class)">ContainsSharedFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/ContentDownload.html" title="DropboxApi::Endpoints::ContentDownload (class)">ContentDownload</a></span>
+
+                <small>(DropboxApi::Endpoints)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span>
+
+                <small>(DropboxApi::Endpoints)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/ConversionError.html" title="DropboxApi::Errors::ConversionError (class)">ConversionError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/Copy.html" title="DropboxApi::Endpoints::Files::Copy (class)">Copy</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/CopyBatch.html" title="DropboxApi::Endpoints::Files::CopyBatch (class)">CopyBatch</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/CopyBatchCheck.html" title="DropboxApi::Endpoints::Files::CopyBatchCheck (class)">CopyBatchCheck</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/CopyBatchResult.html" title="DropboxApi::Results::CopyBatchResult (class)">CopyBatchResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/CopyReferenceGet.html" title="DropboxApi::Endpoints::Files::CopyReferenceGet (class)">CopyReferenceGet</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/CopyReferenceSave.html" title="DropboxApi::Endpoints::Files::CopyReferenceSave (class)">CopyReferenceSave</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/CreateFileRequest.html" title="DropboxApi::Endpoints::Files::CreateFileRequest (class)">CreateFileRequest</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/CreateFileRequestError.html" title="DropboxApi::Errors::CreateFileRequestError (class)">CreateFileRequestError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/CreateFolder.html" title="DropboxApi::Endpoints::Files::CreateFolder (class)">CreateFolder</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/CreateFolderBatch.html" title="DropboxApi::Endpoints::Files::CreateFolderBatch (class)">CreateFolderBatch</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html" title="DropboxApi::Endpoints::Files::CreateFolderBatchCheck (class)">CreateFolderBatchCheck</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/CreateFolderBatchError.html" title="DropboxApi::Errors::CreateFolderBatchError (class)">CreateFolderBatchError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/CreateFolderBatchResult.html" title="DropboxApi::Results::CreateFolderBatchResult (class)">CreateFolderBatchResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/CreateFolderBatchResultEntry.html" title="DropboxApi::Results::CreateFolderBatchResultEntry (class)">CreateFolderBatchResultEntry</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/CreateFolderError.html" title="DropboxApi::Errors::CreateFolderError (class)">CreateFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html" title="DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings (class)">CreateSharedLinkWithSettings</a></span>
+
+                <small>(DropboxApi::Endpoints::Sharing)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/CreateSharedLinkWithSettingsError.html" title="DropboxApi::Errors::CreateSharedLinkWithSettingsError (class)">CreateSharedLinkWithSettingsError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/CursorClosedError.html" title="DropboxApi::Errors::CursorClosedError (class)">CursorClosedError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/CursorNotClosedError.html" title="DropboxApi::Errors::CursorNotClosedError (class)">CursorNotClosedError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_D" class="alpha">
+        <li class="letter">D</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/MiddleWare/DecodeResult.html" title="DropboxApi::MiddleWare::DecodeResult (class)">DecodeResult</a></span>
+
+                <small>(DropboxApi::MiddleWare)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/Delete.html" title="DropboxApi::Endpoints::Files::Delete (class)">Delete</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/DeleteBatch.html" title="DropboxApi::Endpoints::Files::DeleteBatch (class)">DeleteBatch</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/DeleteBatchCheck.html" title="DropboxApi::Endpoints::Files::DeleteBatchCheck (class)">DeleteBatchCheck</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/DeleteBatchResult.html" title="DropboxApi::Results::DeleteBatchResult (class)">DeleteBatchResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/DeleteBatchResultEntry.html" title="DropboxApi::Results::DeleteBatchResultEntry (class)">DeleteBatchResultEntry</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/DeleteError.html" title="DropboxApi::Errors::DeleteError (class)">DeleteError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/Deleted.html" title="DropboxApi::Metadata::Deleted (class)">Deleted</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/Dimensions.html" title="DropboxApi::Metadata::Dimensions (class)">Dimensions</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/DisallowedNameError.html" title="DropboxApi::Errors::DisallowedNameError (class)">DisallowedNameError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/DisallowedSharedLinkPolicyError.html" title="DropboxApi::Errors::DisallowedSharedLinkPolicyError (class)">DisallowedSharedLinkPolicyError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/Download.html" title="DropboxApi::Endpoints::Files::Download (class)">Download</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/DownloadError.html" title="DropboxApi::Errors::DownloadError (class)">DownloadError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/DownloadFailedError.html" title="DropboxApi::Errors::DownloadFailedError (class)">DownloadFailedError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxScaffoldBuilder.html" title="DropboxScaffoldBuilder (class)">DropboxScaffoldBuilder</a></span>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_E" class="alpha">
+        <li class="letter">E</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/EmailUnverifiedError.html" title="DropboxApi::Errors::EmailUnverifiedError (class)">EmailUnverifiedError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span>
+
+                <small>(DropboxApi)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors.html" title="DropboxApi::Errors (module)">Errors</a></span>
+
+                <small>(DropboxApi)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/ExpiredAccessTokenError.html" title="DropboxApi::Errors::ExpiredAccessTokenError (class)">ExpiredAccessTokenError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_F" class="alpha">
+        <li class="letter">F</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/Field.html" title="DropboxApi::Metadata::Field (class)">Field</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/FileAncestorConflictError.html" title="DropboxApi::Errors::FileAncestorConflictError (class)">FileAncestorConflictError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/FileCategoriesList.html" title="DropboxApi::Metadata::FileCategoriesList (class)">FileCategoriesList</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/FileCategory.html" title="DropboxApi::Metadata::FileCategory (class)">FileCategory</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/FileConflictError.html" title="DropboxApi::Errors::FileConflictError (class)">FileConflictError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/FileExtensionsList.html" title="DropboxApi::Metadata::FileExtensionsList (class)">FileExtensionsList</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/FileLinkMetadata.html" title="DropboxApi::Metadata::FileLinkMetadata (class)">FileLinkMetadata</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/FileMemberAction.html" title="DropboxApi::Metadata::FileMemberAction (class)">FileMemberAction</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/FileMemberActionError.html" title="DropboxApi::Errors::FileMemberActionError (class)">FileMemberActionError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/FileRequest.html" title="DropboxApi::Metadata::FileRequest (class)">FileRequest</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/FileStatus.html" title="DropboxApi::Metadata::FileStatus (class)">FileStatus</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span>
+
+                <small>(DropboxApi::Endpoints)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/FolderConflictError.html" title="DropboxApi::Errors::FolderConflictError (class)">FolderConflictError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/FolderLinkMetadata.html" title="DropboxApi::Metadata::FolderLinkMetadata (class)">FolderLinkMetadata</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/FolderSharingInfo.html" title="DropboxApi::Metadata::FolderSharingInfo (class)">FolderSharingInfo</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_G" class="alpha">
+        <li class="letter">G</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Users/GetAccount.html" title="DropboxApi::Endpoints::Users::GetAccount (class)">GetAccount</a></span>
+
+                <small>(DropboxApi::Endpoints::Users)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Users/GetAccountBatch.html" title="DropboxApi::Endpoints::Users::GetAccountBatch (class)">GetAccountBatch</a></span>
+
+                <small>(DropboxApi::Endpoints::Users)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/GetAccountError.html" title="DropboxApi::Errors::GetAccountError (class)">GetAccountError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/GetCopyReferenceError.html" title="DropboxApi::Errors::GetCopyReferenceError (class)">GetCopyReferenceError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">GetCopyReferenceResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Users/GetCurrentAccount.html" title="DropboxApi::Endpoints::Users::GetCurrentAccount (class)">GetCurrentAccount</a></span>
+
+                <small>(DropboxApi::Endpoints::Users)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/GetMetadata.html" title="DropboxApi::Endpoints::Files::GetMetadata (class)">GetMetadata</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/GetMetadataError.html" title="DropboxApi::Errors::GetMetadataError (class)">GetMetadataError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/GetPreview.html" title="DropboxApi::Endpoints::Files::GetPreview (class)">GetPreview</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html" title="DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata (class)">GetSharedLinkMetadata</a></span>
+
+                <small>(DropboxApi::Endpoints::Sharing)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Users/GetSpaceUsage.html" title="DropboxApi::Endpoints::Users::GetSpaceUsage (class)">GetSpaceUsage</a></span>
+
+                <small>(DropboxApi::Endpoints::Users)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/GetTemporaryLink.html" title="DropboxApi::Endpoints::Files::GetTemporaryLink (class)">GetTemporaryLink</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/GetTemporaryLinkResult.html" title="DropboxApi::Results::GetTemporaryLinkResult (class)">GetTemporaryLinkResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/GetThumbnail.html" title="DropboxApi::Endpoints::Files::GetThumbnail (class)">GetThumbnail</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/GetThumbnailBatch.html" title="DropboxApi::Endpoints::Files::GetThumbnailBatch (class)">GetThumbnailBatch</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/GetThumbnailBatchResult.html" title="DropboxApi::Results::GetThumbnailBatchResult (class)">GetThumbnailBatchResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/GroupDeletedError.html" title="DropboxApi::Errors::GroupDeletedError (class)">GroupDeletedError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/GroupNotOnTeamError.html" title="DropboxApi::Errors::GroupNotOnTeamError (class)">GroupNotOnTeamError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+        </td><td valign='top' width="33%">
+
+      <ul id="alpha_H" class="alpha">
+        <li class="letter">H</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/HttpError.html" title="DropboxApi::Errors::HttpError (class)">HttpError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_I" class="alpha">
+        <li class="letter">I</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InProgressError.html" title="DropboxApi::Errors::InProgressError (class)">InProgressError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InsideAppFolderError.html" title="DropboxApi::Errors::InsideAppFolderError (class)">InsideAppFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InsideOsxPackageError.html" title="DropboxApi::Errors::InsideOsxPackageError (class)">InsideOsxPackageError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InsidePublicFolderError.html" title="DropboxApi::Errors::InsidePublicFolderError (class)">InsidePublicFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InsideSharedFolderError.html" title="DropboxApi::Errors::InsideSharedFolderError (class)">InsideSharedFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InsufficientPlanError.html" title="DropboxApi::Errors::InsufficientPlanError (class)">InsufficientPlanError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InsufficientSpaceError.html" title="DropboxApi::Errors::InsufficientSpaceError (class)">InsufficientSpaceError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InternalError.html" title="DropboxApi::Errors::InternalError (class)">InternalError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InvalidCommentError.html" title="DropboxApi::Errors::InvalidCommentError (class)">InvalidCommentError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InvalidCopyReferenceError.html" title="DropboxApi::Errors::InvalidCopyReferenceError (class)">InvalidCopyReferenceError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InvalidCursorError.html" title="DropboxApi::Errors::InvalidCursorError (class)">InvalidCursorError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InvalidDropboxIdError.html" title="DropboxApi::Errors::InvalidDropboxIdError (class)">InvalidDropboxIdError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InvalidEmailError.html" title="DropboxApi::Errors::InvalidEmailError (class)">InvalidEmailError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InvalidFileError.html" title="DropboxApi::Errors::InvalidFileError (class)">InvalidFileError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InvalidIdError.html" title="DropboxApi::Errors::InvalidIdError (class)">InvalidIdError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InvalidMemberError.html" title="DropboxApi::Errors::InvalidMemberError (class)">InvalidMemberError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InvalidPathError.html" title="DropboxApi::Errors::InvalidPathError (class)">InvalidPathError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InvalidRevisionError.html" title="DropboxApi::Errors::InvalidRevisionError (class)">InvalidRevisionError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InvalidSettingsError.html" title="DropboxApi::Errors::InvalidSettingsError (class)">InvalidSettingsError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/InvalidUrlError.html" title="DropboxApi::Errors::InvalidUrlError (class)">InvalidUrlError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/IsAppFolderError.html" title="DropboxApi::Errors::IsAppFolderError (class)">IsAppFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/IsFileError.html" title="DropboxApi::Errors::IsFileError (class)">IsFileError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/IsFolderError.html" title="DropboxApi::Errors::IsFolderError (class)">IsFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/IsOsxPackageError.html" title="DropboxApi::Errors::IsOsxPackageError (class)">IsOsxPackageError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/IsPublicFolderError.html" title="DropboxApi::Errors::IsPublicFolderError (class)">IsPublicFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_L" class="alpha">
+        <li class="letter">L</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/LinkPermissions.html" title="DropboxApi::Metadata::LinkPermissions (class)">LinkPermissions</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/ListFileMembers.html" title="DropboxApi::Endpoints::Sharing::ListFileMembers (class)">ListFileMembers</a></span>
+
+                <small>(DropboxApi::Endpoints::Sharing)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/ListFolder.html" title="DropboxApi::Endpoints::Files::ListFolder (class)">ListFolder</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/ListFolderContinue.html" title="DropboxApi::Endpoints::Files::ListFolderContinue (class)">ListFolderContinue</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/ListFolderContinueError.html" title="DropboxApi::Errors::ListFolderContinueError (class)">ListFolderContinueError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/ListFolderError.html" title="DropboxApi::Errors::ListFolderError (class)">ListFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html" title="DropboxApi::Endpoints::Files::ListFolderGetLatestCursor (class)">ListFolderGetLatestCursor</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/ListFolderGetLatestCursorResult.html" title="DropboxApi::Results::ListFolderGetLatestCursorResult (class)">ListFolderGetLatestCursorResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/ListFolderLongpoll.html" title="DropboxApi::Endpoints::Files::ListFolderLongpoll (class)">ListFolderLongpoll</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/ListFolderLongpollError.html" title="DropboxApi::Errors::ListFolderLongpollError (class)">ListFolderLongpollError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/ListFolderLongpollResult.html" title="DropboxApi::Results::ListFolderLongpollResult (class)">ListFolderLongpollResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/ListFolderMembers.html" title="DropboxApi::Endpoints::Sharing::ListFolderMembers (class)">ListFolderMembers</a></span>
+
+                <small>(DropboxApi::Endpoints::Sharing)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/ListFolderResult.html" title="DropboxApi::Results::ListFolderResult (class)">ListFolderResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/ListRevisions.html" title="DropboxApi::Endpoints::Files::ListRevisions (class)">ListRevisions</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/ListRevisionsError.html" title="DropboxApi::Errors::ListRevisionsError (class)">ListRevisionsError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/ListRevisionsResult.html" title="DropboxApi::Results::ListRevisionsResult (class)">ListRevisionsResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/ListSharedLinks.html" title="DropboxApi::Endpoints::Sharing::ListSharedLinks (class)">ListSharedLinks</a></span>
+
+                <small>(DropboxApi::Endpoints::Sharing)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/ListSharedLinksError.html" title="DropboxApi::Errors::ListSharedLinksError (class)">ListSharedLinksError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/ListSharedLinksResult.html" title="DropboxApi::Results::ListSharedLinksResult (class)">ListSharedLinksResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/Location.html" title="DropboxApi::Metadata::Location (class)">Location</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/LookupError.html" title="DropboxApi::Errors::LookupError (class)">LookupError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_M" class="alpha">
+        <li class="letter">M</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/MalformedPathError.html" title="DropboxApi::Errors::MalformedPathError (class)">MalformedPathError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/Search/Match.html" title="DropboxApi::Results::Search::Match (class)">Match</a></span>
+
+                <small>(DropboxApi::Results::Search)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/MediaInfo.html" title="DropboxApi::Metadata::MediaInfo (class)">MediaInfo</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/MediaMetadata.html" title="DropboxApi::Metadata::MediaMetadata (class)">MediaMetadata</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/Member.html" title="DropboxApi::Metadata::Member (class)">Member</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/MemberAction.html" title="DropboxApi::Metadata::MemberAction (class)">MemberAction</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">MemberActionList</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/MemberPermission.html" title="DropboxApi::Metadata::MemberPermission (class)">MemberPermission</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/MemberPermissionList.html" title="DropboxApi::Metadata::MemberPermissionList (class)">MemberPermissionList</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span>
+
+                <small>(DropboxApi)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/MetadataV2.html" title="DropboxApi::Metadata::MetadataV2 (class)">MetadataV2</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/MiddleWare.html" title="DropboxApi::MiddleWare (module)">MiddleWare</a></span>
+
+                <small>(DropboxApi)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/Move.html" title="DropboxApi::Endpoints::Files::Move (class)">Move</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_N" class="alpha">
+        <li class="letter">N</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/Name.html" title="DropboxApi::Metadata::Name (class)">Name</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/NamespaceId.html" title="DropboxApi::Metadata::NamespaceId (class)">NamespaceId</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/NoAccountError.html" title="DropboxApi::Errors::NoAccountError (class)">NoAccountError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/NoPermissionError.html" title="DropboxApi::Errors::NoPermissionError (class)">NoPermissionError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/NoWritePermissionError.html" title="DropboxApi::Errors::NoWritePermissionError (class)">NoWritePermissionError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/NotAMemberError.html" title="DropboxApi::Errors::NotAMemberError (class)">NotAMemberError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/NotFileError.html" title="DropboxApi::Errors::NotFileError (class)">NotFileError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/NotFolderError.html" title="DropboxApi::Errors::NotFolderError (class)">NotFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_O" class="alpha">
+        <li class="letter">O</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span>
+
+                <small>(DropboxApi)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_P" class="alpha">
+        <li class="letter">P</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/ParentFolderAccessInfo.html" title="DropboxApi::Metadata::ParentFolderAccessInfo (class)">ParentFolderAccessInfo</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/MiddleWare/PathRoot.html" title="DropboxApi::MiddleWare::PathRoot (class)">PathRoot</a></span>
+
+                <small>(DropboxApi::MiddleWare)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/PermanentlyDelete.html" title="DropboxApi::Endpoints::Files::PermanentlyDelete (class)">PermanentlyDelete</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/PhotoMetadata.html" title="DropboxApi::Metadata::PhotoMetadata (class)">PhotoMetadata</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/PollError.html" title="DropboxApi::Errors::PollError (class)">PollError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/PreviewError.html" title="DropboxApi::Errors::PreviewError (class)">PreviewError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_R" class="alpha">
+        <li class="letter">R</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/RateLimitError.html" title="DropboxApi::Errors::RateLimitError (class)">RateLimitError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/RelocationBatchEntryError.html" title="DropboxApi::Errors::RelocationBatchEntryError (class)">RelocationBatchEntryError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/RelocationBatchResult.html" title="DropboxApi::Results::RelocationBatchResult (class)">RelocationBatchResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/RelocationBatchResultEntry.html" title="DropboxApi::Results::RelocationBatchResultEntry (class)">RelocationBatchResultEntry</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/RelocationError.html" title="DropboxApi::Errors::RelocationError (class)">RelocationError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/Restore.html" title="DropboxApi::Endpoints::Files::Restore (class)">Restore</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/RestoreError.html" title="DropboxApi::Errors::RestoreError (class)">RestoreError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/RestrictedContentError.html" title="DropboxApi::Errors::RestrictedContentError (class)">RestrictedContentError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/ResultBuilder.html" title="DropboxApi::ResultBuilder (class)">ResultBuilder</a></span>
+
+                <small>(DropboxApi)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results.html" title="DropboxApi::Results (module)">Results</a></span>
+
+                <small>(DropboxApi)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/RevokeSharedLink.html" title="DropboxApi::Endpoints::Sharing::RevokeSharedLink (class)">RevokeSharedLink</a></span>
+
+                <small>(DropboxApi::Endpoints::Sharing)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/RevokeSharedLinkError.html" title="DropboxApi::Errors::RevokeSharedLinkError (class)">RevokeSharedLinkError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/RootInfo.html" title="DropboxApi::Metadata::RootInfo (class)">RootInfo</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span>
+
+                <small>(DropboxApi::Endpoints)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/RpcContent.html" title="DropboxApi::Endpoints::RpcContent (class)">RpcContent</a></span>
+
+                <small>(DropboxApi::Endpoints)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/RpcNotify.html" title="DropboxApi::Endpoints::RpcNotify (class)">RpcNotify</a></span>
+
+                <small>(DropboxApi::Endpoints)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+        </td><td valign='top' width="33%">
+
+      <ul id="alpha_S" class="alpha">
+        <li class="letter">S</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SaveCopyReferenceError.html" title="DropboxApi::Errors::SaveCopyReferenceError (class)">SaveCopyReferenceError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/SaveCopyReferenceResult.html" title="DropboxApi::Results::SaveCopyReferenceResult (class)">SaveCopyReferenceResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/SaveUrl.html" title="DropboxApi::Endpoints::Files::SaveUrl (class)">SaveUrl</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html" title="DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus (class)">SaveUrlCheckJobStatus</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SaveUrlError.html" title="DropboxApi::Errors::SaveUrlError (class)">SaveUrlError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/SaveUrlJobStatus.html" title="DropboxApi::Results::SaveUrlJobStatus (class)">SaveUrlJobStatus</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/SaveUrlResult.html" title="DropboxApi::Results::SaveUrlResult (class)">SaveUrlResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/Search.html" title="DropboxApi::Results::Search (module)">Search</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/Search.html" title="DropboxApi::Endpoints::Files::Search (class)">Search</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/SearchContinue.html" title="DropboxApi::Endpoints::Files::SearchContinue (class)">SearchContinue</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SearchError.html" title="DropboxApi::Errors::SearchError (class)">SearchError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/SearchMatchFieldOptions.html" title="DropboxApi::Metadata::SearchMatchFieldOptions (class)">SearchMatchFieldOptions</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/SearchMatchTypeV2.html" title="DropboxApi::Metadata::SearchMatchTypeV2 (class)">SearchMatchTypeV2</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/SearchMatchV2.html" title="DropboxApi::Metadata::SearchMatchV2 (class)">SearchMatchV2</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/SearchOptions.html" title="DropboxApi::Metadata::SearchOptions (class)">SearchOptions</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/SearchOrderBy.html" title="DropboxApi::Metadata::SearchOrderBy (class)">SearchOrderBy</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/SearchV2Result.html" title="DropboxApi::Results::SearchV2Result (class)">SearchV2Result</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SettingsError.html" title="DropboxApi::Errors::SettingsError (class)">SettingsError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/ShareFolder.html" title="DropboxApi::Endpoints::Sharing::ShareFolder (class)">ShareFolder</a></span>
+
+                <small>(DropboxApi::Endpoints::Sharing)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/ShareFolderError.html" title="DropboxApi::Errors::ShareFolderError (class)">ShareFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/ShareFolderLaunch.html" title="DropboxApi::Results::ShareFolderLaunch (class)">ShareFolderLaunch</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SharePathError.html" title="DropboxApi::Errors::SharePathError (class)">SharePathError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/SharedFileMembers.html" title="DropboxApi::Results::SharedFileMembers (class)">SharedFileMembers</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/SharedFolder.html" title="DropboxApi::Metadata::SharedFolder (class)">SharedFolder</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SharedFolderAccessError.html" title="DropboxApi::Errors::SharedFolderAccessError (class)">SharedFolderAccessError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/SharedFolderMembers.html" title="DropboxApi::Results::SharedFolderMembers (class)">SharedFolderMembers</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/SharedFolderPolicy.html" title="DropboxApi::Metadata::SharedFolderPolicy (class)">SharedFolderPolicy</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/SharedLink.html" title="DropboxApi::Metadata::SharedLink (class)">SharedLink</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SharedLinkAccessDeniedError.html" title="DropboxApi::Errors::SharedLinkAccessDeniedError (class)">SharedLinkAccessDeniedError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SharedLinkAlreadyExistsError.html" title="DropboxApi::Errors::SharedLinkAlreadyExistsError (class)">SharedLinkAlreadyExistsError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SharedLinkError.html" title="DropboxApi::Errors::SharedLinkError (class)">SharedLinkError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SharedLinkMalformedError.html" title="DropboxApi::Errors::SharedLinkMalformedError (class)">SharedLinkMalformedError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">SharedLinkMetadata</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SharedLinkNotFoundError.html" title="DropboxApi::Errors::SharedLinkNotFoundError (class)">SharedLinkNotFoundError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span>
+
+                <small>(DropboxApi::Endpoints)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SharingFileAccessError.html" title="DropboxApi::Errors::SharingFileAccessError (class)">SharingFileAccessError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/SharingUserError.html" title="DropboxApi::Errors::SharingUserError (class)">SharingUserError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/SpaceAllocation.html" title="DropboxApi::Metadata::SpaceAllocation (class)">SpaceAllocation</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/SpaceUsage.html" title="DropboxApi::Metadata::SpaceUsage (class)">SpaceUsage</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/MiddleWare/Stack.html" title="DropboxApi::MiddleWare::Stack (class)">Stack</a></span>
+
+                <small>(DropboxApi::MiddleWare)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_T" class="alpha">
+        <li class="letter">T</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/Tag.html" title="DropboxApi::Metadata::Tag (class)">Tag</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/Team.html" title="DropboxApi::Metadata::Team (class)">Team</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/TeamFolderError.html" title="DropboxApi::Errors::TeamFolderError (class)">TeamFolderError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/TeamMemberInfo.html" title="DropboxApi::Metadata::TeamMemberInfo (class)">TeamMemberInfo</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html" title="DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError (class)">TeamPolicyDisallowsMemberPolicyError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/TeamRootInfo.html" title="DropboxApi::Metadata::TeamRootInfo (class)">TeamRootInfo</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/ThumbnailBatchError.html" title="DropboxApi::Errors::ThumbnailBatchError (class)">ThumbnailBatchError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/ThumbnailBatchResultData.html" title="DropboxApi::Metadata::ThumbnailBatchResultData (class)">ThumbnailBatchResultData</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/ThumbnailBatchResultEntry.html" title="DropboxApi::Metadata::ThumbnailBatchResultEntry (class)">ThumbnailBatchResultEntry</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/ThumbnailError.html" title="DropboxApi::Errors::ThumbnailError (class)">ThumbnailError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Auth/TokenRevoke.html" title="DropboxApi::Endpoints::Auth::TokenRevoke (class)">TokenRevoke</a></span>
+
+                <small>(DropboxApi::Endpoints::Auth)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/TooManyFilesError.html" title="DropboxApi::Errors::TooManyFilesError (class)">TooManyFilesError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/TooManyMembersError.html" title="DropboxApi::Errors::TooManyMembersError (class)">TooManyMembersError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/TooManyPendingInvitesError.html" title="DropboxApi::Errors::TooManyPendingInvitesError (class)">TooManyPendingInvitesError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/TooManyRequestsError.html" title="DropboxApi::Errors::TooManyRequestsError (class)">TooManyRequestsError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/TooManySharedFolderTargetsError.html" title="DropboxApi::Errors::TooManySharedFolderTargetsError (class)">TooManySharedFolderTargetsError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/TooManyWriteOperationsError.html" title="DropboxApi::Errors::TooManyWriteOperationsError (class)">TooManyWriteOperationsError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_U" class="alpha">
+        <li class="letter">U</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/UnmountedError.html" title="DropboxApi::Errors::UnmountedError (class)">UnmountedError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/UnshareFile.html" title="DropboxApi::Endpoints::Sharing::UnshareFile (class)">UnshareFile</a></span>
+
+                <small>(DropboxApi::Endpoints::Sharing)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/UnshareFileError.html" title="DropboxApi::Errors::UnshareFileError (class)">UnshareFileError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/UnsupportedContentError.html" title="DropboxApi::Errors::UnsupportedContentError (class)">UnsupportedContentError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/UnsupportedExtensionError.html" title="DropboxApi::Errors::UnsupportedExtensionError (class)">UnsupportedExtensionError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/UnsupportedImageError.html" title="DropboxApi::Errors::UnsupportedImageError (class)">UnsupportedImageError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/UnsupportedLinkTypeError.html" title="DropboxApi::Errors::UnsupportedLinkTypeError (class)">UnsupportedLinkTypeError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/UnverifiedDropboxId.html" title="DropboxApi::Errors::UnverifiedDropboxId (class)">UnverifiedDropboxId</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/Upload.html" title="DropboxApi::Endpoints::Files::Upload (class)">Upload</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/UploadError.html" title="DropboxApi::Errors::UploadError (class)">UploadError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/UploadSessionAppendV2.html" title="DropboxApi::Endpoints::Files::UploadSessionAppendV2 (class)">UploadSessionAppendV2</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">UploadSessionCursor</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/UploadSessionFinish.html" title="DropboxApi::Endpoints::Files::UploadSessionFinish (class)">UploadSessionFinish</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/UploadSessionFinishError.html" title="DropboxApi::Errors::UploadSessionFinishError (class)">UploadSessionFinishError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/UploadSessionLookupError.html" title="DropboxApi::Errors::UploadSessionLookupError (class)">UploadSessionLookupError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/UploadSessionOffsetError.html" title="DropboxApi::Errors::UploadSessionOffsetError (class)">UploadSessionOffsetError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Files/UploadSessionStart.html" title="DropboxApi::Endpoints::Files::UploadSessionStart (class)">UploadSessionStart</a></span>
+
+                <small>(DropboxApi::Endpoints::Files)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/UploadSessionStart.html" title="DropboxApi::Results::UploadSessionStart (class)">UploadSessionStart</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/UploadWriteFailedError.html" title="DropboxApi::Errors::UploadWriteFailedError (class)">UploadWriteFailedError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/UserRootInfo.html" title="DropboxApi::Metadata::UserRootInfo (class)">UserRootInfo</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Endpoints/Users.html" title="DropboxApi::Endpoints::Users (module)">Users</a></span>
+
+                <small>(DropboxApi::Endpoints)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_V" class="alpha">
+        <li class="letter">V</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/VideoMetadata.html" title="DropboxApi::Metadata::VideoMetadata (class)">VideoMetadata</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Results/VoidResult.html" title="DropboxApi::Results::VoidResult (class)">VoidResult</a></span>
+
+                <small>(DropboxApi::Results)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+      <ul id="alpha_W" class="alpha">
+        <li class="letter">W</li>
+        <ul>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/WriteConflictError.html" title="DropboxApi::Errors::WriteConflictError (class)">WriteConflictError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Errors/WriteError.html" title="DropboxApi::Errors::WriteError (class)">WriteError</a></span>
+
+                <small>(DropboxApi::Errors)</small>
+
+            </li>
+
+            <li>
+              <span class='object_link'><a href="DropboxApi/Metadata/WriteMode.html" title="DropboxApi::Metadata::WriteMode (class)">WriteMode</a></span>
+
+                <small>(DropboxApi::Metadata)</small>
+
+            </li>
+
+        </ul>
+      </ul>
+
+  </td>
+</tr>
+ +

</table>

+ +

</div>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/class_list_html.html b/doc/docs/class_list_html.html new file mode 100644 index 00000000..7d991b9b --- /dev/null +++ b/doc/docs/class_list_html.html @@ -0,0 +1,3145 @@ + + + + + + +class_list.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta charset="utf-8" />
+
+    <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
+
+    <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
+
+    <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+    <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+
+  <title>Class List</title>
+  <base id="base_target" target="_parent" />
+</head>
+<body>
+  <div id="content">
+    <div class="fixed_header">
+      <h1 id="full_list_header">Class List</h1>
+      <div id="full_list_nav">
+
+          <span><a target="_self" href="class_list.html">
+            Classes
+          </a></span>
+
+          <span><a target="_self" href="method_list.html">
+            Methods
+          </a></span>
+
+          <span><a target="_self" href="file_list.html">
+            Files
+          </a></span>
+
+      </div>
+
+      <div id="search">Search: <input type="text" /></div>
+    </div>
+
+    <ul id="full_list" class="class">
+      <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
+ +

<li id='object_DropboxApi' class='even'><div +class='item' style='padding-left:30px'><a +class='toggle'></a> <span +class='object_link'><a href=“DropboxApi.html” +title=“DropboxApi (module)”>DropboxApi</a></span><small +class='search_info'>Top Level +Namespace</small></div><ul><li +id='object_DropboxApi::Authenticator' class='collapsed +odd'><div class='item' +style='padding-left:45px'><span +class='object_link'><a href=“DropboxApi/Authenticator.html” +title=“DropboxApi::Authenticator +(class)”>Authenticator</a></span> &lt; Client<small +class='search_info'>DropboxApi</small></div></li><li +id='object_DropboxApi::ChunkedUploader' class='collapsed +even'><div class='item' +style='padding-left:45px'><span +class='object_link'><a href=“DropboxApi/ChunkedUploader.html” +title=“DropboxApi::ChunkedUploader +(class)”>ChunkedUploader</a></span> &lt; Object<small +class='search_info'>DropboxApi</small></div></li><li +id='object_DropboxApi::Client' class='collapsed +odd'><div class='item' +style='padding-left:45px'><span +class='object_link'><a href=“DropboxApi/Client.html” +title=“DropboxApi::Client (class)”>Client</a></span> +&lt; Object<small +class='search_info'>DropboxApi</small></div></li><li +id='object_DropboxApi::ConnectionBuilder' class='collapsed +even'><div class='item' +style='padding-left:45px'><span +class='object_link'><a +href=“DropboxApi/ConnectionBuilder.html” +title=“DropboxApi::ConnectionBuilder +(class)”>ConnectionBuilder</a></span> &lt; Object<small +class='search_info'>DropboxApi</small></div></li><li +id='object_DropboxApi::Endpoints' class='collapsed +odd'><div class='item' +style='padding-left:45px'><a +class='toggle'></a> <span +class='object_link'><a href=“DropboxApi/Endpoints.html” +title=“DropboxApi::Endpoints +(module)”>Endpoints</a></span><small +class='search_info'>DropboxApi</small></div><ul><li +id='object_DropboxApi::Endpoints::Auth' +class='collapsed'><div class='item' +style='padding-left:60px'><a +class='toggle'></a> <span +class='object_link'><a href=“DropboxApi/Endpoints/Auth.html” +title=“DropboxApi::Endpoints::Auth +(module)”>Auth</a></span><small +class='search_info'>DropboxApi::Endpoints</small></div><ul><li +id='object_DropboxApi::Endpoints::Auth::TokenRevoke' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Auth/TokenRevoke.html” +title=“DropboxApi::Endpoints::Auth::TokenRevoke +(class)”>TokenRevoke</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Auth</small></div></li></ul></li><li +id='object_DropboxApi::Endpoints::Base' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a href=“DropboxApi/Endpoints/Base.html” +title=“DropboxApi::Endpoints::Base (class)”>Base</a></span> +&lt; Object<small +class='search_info'>DropboxApi::Endpoints</small></div></li><li +id='object_DropboxApi::Endpoints::ContentDownload' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/ContentDownload.html” +title=“DropboxApi::Endpoints::ContentDownload +(class)”>ContentDownload</a></span> &lt; Base<small +class='search_info'>DropboxApi::Endpoints</small></div></li><li +id='object_DropboxApi::Endpoints::ContentUpload' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/ContentUpload.html” +title=“DropboxApi::Endpoints::ContentUpload +(class)”>ContentUpload</a></span> &lt; Base<small +class='search_info'>DropboxApi::Endpoints</small></div></li><li +id='object_DropboxApi::Endpoints::Files' +class='collapsed'><div class='item' +style='padding-left:60px'><a +class='toggle'></a> <span +class='object_link'><a href=“DropboxApi/Endpoints/Files.html” +title=“DropboxApi::Endpoints::Files +(module)”>Files</a></span><small +class='search_info'>DropboxApi::Endpoints</small></div><ul><li +id='object_DropboxApi::Endpoints::Files::Copy' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/Copy.html” +title=“DropboxApi::Endpoints::Files::Copy +(class)”>Copy</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::CopyBatch' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/CopyBatch.html” +title=“DropboxApi::Endpoints::Files::CopyBatch +(class)”>CopyBatch</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::CopyBatchCheck' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/CopyBatchCheck.html” +title=“DropboxApi::Endpoints::Files::CopyBatchCheck +(class)”>CopyBatchCheck</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::CopyReferenceGet' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/CopyReferenceGet.html” +title=“DropboxApi::Endpoints::Files::CopyReferenceGet +(class)”>CopyReferenceGet</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::CopyReferenceSave' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/CopyReferenceSave.html” +title=“DropboxApi::Endpoints::Files::CopyReferenceSave +(class)”>CopyReferenceSave</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::CreateFileRequest' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/CreateFileRequest.html” +title=“DropboxApi::Endpoints::Files::CreateFileRequest +(class)”>CreateFileRequest</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::CreateFolder' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/CreateFolder.html” +title=“DropboxApi::Endpoints::Files::CreateFolder +(class)”>CreateFolder</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::CreateFolderBatch' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/CreateFolderBatch.html” +title=“DropboxApi::Endpoints::Files::CreateFolderBatch +(class)”>CreateFolderBatch</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::CreateFolderBatchCheck' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html” +title=“DropboxApi::Endpoints::Files::CreateFolderBatchCheck +(class)”>CreateFolderBatchCheck</a></span> &lt; +Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::Delete' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/Delete.html” +title=“DropboxApi::Endpoints::Files::Delete +(class)”>Delete</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::DeleteBatch' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/DeleteBatch.html” +title=“DropboxApi::Endpoints::Files::DeleteBatch +(class)”>DeleteBatch</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::DeleteBatchCheck' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/DeleteBatchCheck.html” +title=“DropboxApi::Endpoints::Files::DeleteBatchCheck +(class)”>DeleteBatchCheck</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::Download' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/Download.html” +title=“DropboxApi::Endpoints::Files::Download +(class)”>Download</a></span> &lt; +ContentDownload<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::GetMetadata' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/GetMetadata.html” +title=“DropboxApi::Endpoints::Files::GetMetadata +(class)”>GetMetadata</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::GetPreview' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/GetPreview.html” +title=“DropboxApi::Endpoints::Files::GetPreview +(class)”>GetPreview</a></span> &lt; +ContentDownload<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::GetTemporaryLink' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/GetTemporaryLink.html” +title=“DropboxApi::Endpoints::Files::GetTemporaryLink +(class)”>GetTemporaryLink</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::GetThumbnail' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/GetThumbnail.html” +title=“DropboxApi::Endpoints::Files::GetThumbnail +(class)”>GetThumbnail</a></span> &lt; +ContentDownload<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::GetThumbnailBatch' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/GetThumbnailBatch.html” +title=“DropboxApi::Endpoints::Files::GetThumbnailBatch +(class)”>GetThumbnailBatch</a></span> &lt; +RpcContent<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::ListFolder' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/ListFolder.html” +title=“DropboxApi::Endpoints::Files::ListFolder +(class)”>ListFolder</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::ListFolderContinue' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/ListFolderContinue.html” +title=“DropboxApi::Endpoints::Files::ListFolderContinue +(class)”>ListFolderContinue</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::ListFolderGetLatestCursor' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html” +title=“DropboxApi::Endpoints::Files::ListFolderGetLatestCursor +(class)”>ListFolderGetLatestCursor</a></span> &lt; +Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::ListFolderLongpoll' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/ListFolderLongpoll.html” +title=“DropboxApi::Endpoints::Files::ListFolderLongpoll +(class)”>ListFolderLongpoll</a></span> &lt; +RpcNotify<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::ListRevisions' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/ListRevisions.html” +title=“DropboxApi::Endpoints::Files::ListRevisions +(class)”>ListRevisions</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::Move' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/Move.html” +title=“DropboxApi::Endpoints::Files::Move +(class)”>Move</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::PermanentlyDelete' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/PermanentlyDelete.html” +title=“DropboxApi::Endpoints::Files::PermanentlyDelete +(class)”>PermanentlyDelete</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::Restore' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/Restore.html” +title=“DropboxApi::Endpoints::Files::Restore +(class)”>Restore</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::SaveUrl' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/SaveUrl.html” +title=“DropboxApi::Endpoints::Files::SaveUrl +(class)”>SaveUrl</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html” +title=“DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus +(class)”>SaveUrlCheckJobStatus</a></span> &lt; +Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::Search' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/Search.html” +title=“DropboxApi::Endpoints::Files::Search +(class)”>Search</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::SearchContinue' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/SearchContinue.html” +title=“DropboxApi::Endpoints::Files::SearchContinue +(class)”>SearchContinue</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::Upload' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/Upload.html” +title=“DropboxApi::Endpoints::Files::Upload +(class)”>Upload</a></span> &lt; ContentUpload<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::UploadSessionAppendV2' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/UploadSessionAppendV2.html” +title=“DropboxApi::Endpoints::Files::UploadSessionAppendV2 +(class)”>UploadSessionAppendV2</a></span> &lt; +ContentUpload<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::UploadSessionFinish' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/UploadSessionFinish.html” +title=“DropboxApi::Endpoints::Files::UploadSessionFinish +(class)”>UploadSessionFinish</a></span> &lt; +ContentUpload<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li><li +id='object_DropboxApi::Endpoints::Files::UploadSessionStart' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Files/UploadSessionStart.html” +title=“DropboxApi::Endpoints::Files::UploadSessionStart +(class)”>UploadSessionStart</a></span> &lt; +ContentUpload<small +class='search_info'>DropboxApi::Endpoints::Files</small></div></li></ul></li><li +id='object_DropboxApi::Endpoints::Rpc' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a href=“DropboxApi/Endpoints/Rpc.html” +title=“DropboxApi::Endpoints::Rpc (class)”>Rpc</a></span> +&lt; Base<small +class='search_info'>DropboxApi::Endpoints</small></div></li><li +id='object_DropboxApi::Endpoints::RpcContent' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/RpcContent.html” +title=“DropboxApi::Endpoints::RpcContent +(class)”>RpcContent</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints</small></div></li><li +id='object_DropboxApi::Endpoints::RpcNotify' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/RpcNotify.html” +title=“DropboxApi::Endpoints::RpcNotify +(class)”>RpcNotify</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints</small></div></li><li +id='object_DropboxApi::Endpoints::Sharing' +class='collapsed'><div class='item' +style='padding-left:60px'><a +class='toggle'></a> <span +class='object_link'><a +href=“DropboxApi/Endpoints/Sharing.html” +title=“DropboxApi::Endpoints::Sharing +(module)”>Sharing</a></span><small +class='search_info'>DropboxApi::Endpoints</small></div><ul><li +id='object_DropboxApi::Endpoints::Sharing::AddFileMember' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Sharing/AddFileMember.html” +title=“DropboxApi::Endpoints::Sharing::AddFileMember +(class)”>AddFileMember</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Sharing</small></div></li><li +id='object_DropboxApi::Endpoints::Sharing::AddFolderMember' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Sharing/AddFolderMember.html” +title=“DropboxApi::Endpoints::Sharing::AddFolderMember +(class)”>AddFolderMember</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Sharing</small></div></li><li +id='object_DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html” +title=“DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings +(class)”>CreateSharedLinkWithSettings</a></span> &lt; +Rpc<small +class='search_info'>DropboxApi::Endpoints::Sharing</small></div></li><li +id='object_DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html” +title=“DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata +(class)”>GetSharedLinkMetadata</a></span> &lt; +Rpc<small +class='search_info'>DropboxApi::Endpoints::Sharing</small></div></li><li +id='object_DropboxApi::Endpoints::Sharing::ListFileMembers' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Sharing/ListFileMembers.html” +title=“DropboxApi::Endpoints::Sharing::ListFileMembers +(class)”>ListFileMembers</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Sharing</small></div></li><li +id='object_DropboxApi::Endpoints::Sharing::ListFolderMembers' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Sharing/ListFolderMembers.html” +title=“DropboxApi::Endpoints::Sharing::ListFolderMembers +(class)”>ListFolderMembers</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Sharing</small></div></li><li +id='object_DropboxApi::Endpoints::Sharing::ListSharedLinks' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Sharing/ListSharedLinks.html” +title=“DropboxApi::Endpoints::Sharing::ListSharedLinks +(class)”>ListSharedLinks</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Sharing</small></div></li><li +id='object_DropboxApi::Endpoints::Sharing::RevokeSharedLink' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Sharing/RevokeSharedLink.html” +title=“DropboxApi::Endpoints::Sharing::RevokeSharedLink +(class)”>RevokeSharedLink</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Sharing</small></div></li><li +id='object_DropboxApi::Endpoints::Sharing::ShareFolder' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Sharing/ShareFolder.html” +title=“DropboxApi::Endpoints::Sharing::ShareFolder +(class)”>ShareFolder</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Sharing</small></div></li><li +id='object_DropboxApi::Endpoints::Sharing::UnshareFile' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Sharing/UnshareFile.html” +title=“DropboxApi::Endpoints::Sharing::UnshareFile +(class)”>UnshareFile</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Sharing</small></div></li></ul></li><li +id='object_DropboxApi::Endpoints::Users' +class='collapsed'><div class='item' +style='padding-left:60px'><a +class='toggle'></a> <span +class='object_link'><a href=“DropboxApi/Endpoints/Users.html” +title=“DropboxApi::Endpoints::Users +(module)”>Users</a></span><small +class='search_info'>DropboxApi::Endpoints</small></div><ul><li +id='object_DropboxApi::Endpoints::Users::GetAccount' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Users/GetAccount.html” +title=“DropboxApi::Endpoints::Users::GetAccount +(class)”>GetAccount</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Users</small></div></li><li +id='object_DropboxApi::Endpoints::Users::GetAccountBatch' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Users/GetAccountBatch.html” +title=“DropboxApi::Endpoints::Users::GetAccountBatch +(class)”>GetAccountBatch</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Users</small></div></li><li +id='object_DropboxApi::Endpoints::Users::GetCurrentAccount' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Users/GetCurrentAccount.html” +title=“DropboxApi::Endpoints::Users::GetCurrentAccount +(class)”>GetCurrentAccount</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Users</small></div></li><li +id='object_DropboxApi::Endpoints::Users::GetSpaceUsage' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Endpoints/Users/GetSpaceUsage.html” +title=“DropboxApi::Endpoints::Users::GetSpaceUsage +(class)”>GetSpaceUsage</a></span> &lt; Rpc<small +class='search_info'>DropboxApi::Endpoints::Users</small></div></li></ul></li></ul></li><li +id='object_DropboxApi::Errors' class='collapsed +even'><div class='item' +style='padding-left:45px'><a +class='toggle'></a> <span +class='object_link'><a href=“DropboxApi/Errors.html” +title=“DropboxApi::Errors +(module)”>Errors</a></span><small +class='search_info'>DropboxApi</small></div><ul><li +id='object_DropboxApi::Errors::AddFileMemberError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/AddFileMemberError.html” +title=“DropboxApi::Errors::AddFileMemberError +(class)”>AddFileMemberError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::AddFolderMemberError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/AddFolderMemberError.html” +title=“DropboxApi::Errors::AddFolderMemberError +(class)”>AddFolderMemberError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::AddMemberSelectorError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/AddMemberSelectorError.html” +title=“DropboxApi::Errors::AddMemberSelectorError +(class)”>AddMemberSelectorError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::AlreadySharedError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/AlreadySharedError.html” +title=“DropboxApi::Errors::AlreadySharedError +(class)”>AlreadySharedError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::BadPathError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/BadPathError.html” +title=“DropboxApi::Errors::BadPathError +(class)”>BadPathError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::BasicError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/BasicError.html” +title=“DropboxApi::Errors::BasicError +(class)”>BasicError</a></span> &lt; +StandardError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::CantCopySharedFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/CantCopySharedFolderError.html” +title=“DropboxApi::Errors::CantCopySharedFolderError +(class)”>CantCopySharedFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::CantMoveFolderIntoItselfError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/CantMoveFolderIntoItselfError.html” +title=“DropboxApi::Errors::CantMoveFolderIntoItselfError +(class)”>CantMoveFolderIntoItselfError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::CantNestSharedFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/CantNestSharedFolderError.html” +title=“DropboxApi::Errors::CantNestSharedFolderError +(class)”>CantNestSharedFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::CantShareOutsideTeamError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/CantShareOutsideTeamError.html” +title=“DropboxApi::Errors::CantShareOutsideTeamError +(class)”>CantShareOutsideTeamError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::ContainsSharedFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/ContainsSharedFolderError.html” +title=“DropboxApi::Errors::ContainsSharedFolderError +(class)”>ContainsSharedFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::ConversionError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/ConversionError.html” +title=“DropboxApi::Errors::ConversionError +(class)”>ConversionError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::CreateFileRequestError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/CreateFileRequestError.html” +title=“DropboxApi::Errors::CreateFileRequestError +(class)”>CreateFileRequestError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::CreateFolderBatchError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/CreateFolderBatchError.html” +title=“DropboxApi::Errors::CreateFolderBatchError +(class)”>CreateFolderBatchError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::CreateFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/CreateFolderError.html” +title=“DropboxApi::Errors::CreateFolderError +(class)”>CreateFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::CreateSharedLinkWithSettingsError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/CreateSharedLinkWithSettingsError.html” +title=“DropboxApi::Errors::CreateSharedLinkWithSettingsError +(class)”>CreateSharedLinkWithSettingsError</a></span> +&lt; BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::CursorClosedError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/CursorClosedError.html” +title=“DropboxApi::Errors::CursorClosedError +(class)”>CursorClosedError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::CursorNotClosedError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/CursorNotClosedError.html” +title=“DropboxApi::Errors::CursorNotClosedError +(class)”>CursorNotClosedError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::DeleteError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/DeleteError.html” +title=“DropboxApi::Errors::DeleteError +(class)”>DeleteError</a></span> &lt; BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::DisallowedNameError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/DisallowedNameError.html” +title=“DropboxApi::Errors::DisallowedNameError +(class)”>DisallowedNameError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::DisallowedSharedLinkPolicyError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/DisallowedSharedLinkPolicyError.html” +title=“DropboxApi::Errors::DisallowedSharedLinkPolicyError +(class)”>DisallowedSharedLinkPolicyError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::DownloadError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/DownloadError.html” +title=“DropboxApi::Errors::DownloadError +(class)”>DownloadError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::DownloadFailedError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/DownloadFailedError.html” +title=“DropboxApi::Errors::DownloadFailedError +(class)”>DownloadFailedError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::EmailUnverifiedError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/EmailUnverifiedError.html” +title=“DropboxApi::Errors::EmailUnverifiedError +(class)”>EmailUnverifiedError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::ExpiredAccessTokenError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/ExpiredAccessTokenError.html” +title=“DropboxApi::Errors::ExpiredAccessTokenError +(class)”>ExpiredAccessTokenError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::FileAncestorConflictError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/FileAncestorConflictError.html” +title=“DropboxApi::Errors::FileAncestorConflictError +(class)”>FileAncestorConflictError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::FileConflictError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/FileConflictError.html” +title=“DropboxApi::Errors::FileConflictError +(class)”>FileConflictError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::FileMemberActionError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/FileMemberActionError.html” +title=“DropboxApi::Errors::FileMemberActionError +(class)”>FileMemberActionError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::FolderConflictError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/FolderConflictError.html” +title=“DropboxApi::Errors::FolderConflictError +(class)”>FolderConflictError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::GetAccountError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/GetAccountError.html” +title=“DropboxApi::Errors::GetAccountError +(class)”>GetAccountError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::GetCopyReferenceError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/GetCopyReferenceError.html” +title=“DropboxApi::Errors::GetCopyReferenceError +(class)”>GetCopyReferenceError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::GetMetadataError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/GetMetadataError.html” +title=“DropboxApi::Errors::GetMetadataError +(class)”>GetMetadataError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::GroupDeletedError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/GroupDeletedError.html” +title=“DropboxApi::Errors::GroupDeletedError +(class)”>GroupDeletedError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::GroupNotOnTeamError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/GroupNotOnTeamError.html” +title=“DropboxApi::Errors::GroupNotOnTeamError +(class)”>GroupNotOnTeamError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::HttpError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/HttpError.html” +title=“DropboxApi::Errors::HttpError +(class)”>HttpError</a></span> &lt; +StandardError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InProgressError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InProgressError.html” +title=“DropboxApi::Errors::InProgressError +(class)”>InProgressError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InsideAppFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InsideAppFolderError.html” +title=“DropboxApi::Errors::InsideAppFolderError +(class)”>InsideAppFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InsideOsxPackageError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InsideOsxPackageError.html” +title=“DropboxApi::Errors::InsideOsxPackageError +(class)”>InsideOsxPackageError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InsidePublicFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InsidePublicFolderError.html” +title=“DropboxApi::Errors::InsidePublicFolderError +(class)”>InsidePublicFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InsideSharedFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InsideSharedFolderError.html” +title=“DropboxApi::Errors::InsideSharedFolderError +(class)”>InsideSharedFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InsufficientPlanError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InsufficientPlanError.html” +title=“DropboxApi::Errors::InsufficientPlanError +(class)”>InsufficientPlanError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InsufficientSpaceError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InsufficientSpaceError.html” +title=“DropboxApi::Errors::InsufficientSpaceError +(class)”>InsufficientSpaceError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InternalError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InternalError.html” +title=“DropboxApi::Errors::InternalError +(class)”>InternalError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InvalidCommentError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InvalidCommentError.html” +title=“DropboxApi::Errors::InvalidCommentError +(class)”>InvalidCommentError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InvalidCopyReferenceError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InvalidCopyReferenceError.html” +title=“DropboxApi::Errors::InvalidCopyReferenceError +(class)”>InvalidCopyReferenceError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InvalidCursorError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InvalidCursorError.html” +title=“DropboxApi::Errors::InvalidCursorError +(class)”>InvalidCursorError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InvalidDropboxIdError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InvalidDropboxIdError.html” +title=“DropboxApi::Errors::InvalidDropboxIdError +(class)”>InvalidDropboxIdError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InvalidEmailError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InvalidEmailError.html” +title=“DropboxApi::Errors::InvalidEmailError +(class)”>InvalidEmailError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InvalidFileError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InvalidFileError.html” +title=“DropboxApi::Errors::InvalidFileError +(class)”>InvalidFileError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InvalidIdError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InvalidIdError.html” +title=“DropboxApi::Errors::InvalidIdError +(class)”>InvalidIdError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InvalidMemberError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InvalidMemberError.html” +title=“DropboxApi::Errors::InvalidMemberError +(class)”>InvalidMemberError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InvalidPathError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InvalidPathError.html” +title=“DropboxApi::Errors::InvalidPathError +(class)”>InvalidPathError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InvalidRevisionError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InvalidRevisionError.html” +title=“DropboxApi::Errors::InvalidRevisionError +(class)”>InvalidRevisionError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InvalidSettingsError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InvalidSettingsError.html” +title=“DropboxApi::Errors::InvalidSettingsError +(class)”>InvalidSettingsError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::InvalidUrlError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/InvalidUrlError.html” +title=“DropboxApi::Errors::InvalidUrlError +(class)”>InvalidUrlError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::IsAppFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/IsAppFolderError.html” +title=“DropboxApi::Errors::IsAppFolderError +(class)”>IsAppFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::IsFileError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/IsFileError.html” +title=“DropboxApi::Errors::IsFileError +(class)”>IsFileError</a></span> &lt; BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::IsFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/IsFolderError.html” +title=“DropboxApi::Errors::IsFolderError +(class)”>IsFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::IsOsxPackageError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/IsOsxPackageError.html” +title=“DropboxApi::Errors::IsOsxPackageError +(class)”>IsOsxPackageError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::IsPublicFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/IsPublicFolderError.html” +title=“DropboxApi::Errors::IsPublicFolderError +(class)”>IsPublicFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::ListFolderContinueError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/ListFolderContinueError.html” +title=“DropboxApi::Errors::ListFolderContinueError +(class)”>ListFolderContinueError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::ListFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/ListFolderError.html” +title=“DropboxApi::Errors::ListFolderError +(class)”>ListFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::ListFolderLongpollError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/ListFolderLongpollError.html” +title=“DropboxApi::Errors::ListFolderLongpollError +(class)”>ListFolderLongpollError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::ListRevisionsError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/ListRevisionsError.html” +title=“DropboxApi::Errors::ListRevisionsError +(class)”>ListRevisionsError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::ListSharedLinksError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/ListSharedLinksError.html” +title=“DropboxApi::Errors::ListSharedLinksError +(class)”>ListSharedLinksError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::LookupError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/LookupError.html” +title=“DropboxApi::Errors::LookupError +(class)”>LookupError</a></span> &lt; BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::MalformedPathError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/MalformedPathError.html” +title=“DropboxApi::Errors::MalformedPathError +(class)”>MalformedPathError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::NoAccountError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/NoAccountError.html” +title=“DropboxApi::Errors::NoAccountError +(class)”>NoAccountError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::NoPermissionError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/NoPermissionError.html” +title=“DropboxApi::Errors::NoPermissionError +(class)”>NoPermissionError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::NoWritePermissionError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/NoWritePermissionError.html” +title=“DropboxApi::Errors::NoWritePermissionError +(class)”>NoWritePermissionError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::NotAMemberError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/NotAMemberError.html” +title=“DropboxApi::Errors::NotAMemberError +(class)”>NotAMemberError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::NotFileError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/NotFileError.html” +title=“DropboxApi::Errors::NotFileError +(class)”>NotFileError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::NotFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/NotFolderError.html” +title=“DropboxApi::Errors::NotFolderError +(class)”>NotFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::NotFoundError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/NotFoundError.html” +title=“DropboxApi::Errors::NotFoundError +(class)”>NotFoundError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::PollError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/PollError.html” +title=“DropboxApi::Errors::PollError +(class)”>PollError</a></span> &lt; BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::PreviewError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/PreviewError.html” +title=“DropboxApi::Errors::PreviewError +(class)”>PreviewError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::RateLimitError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/RateLimitError.html” +title=“DropboxApi::Errors::RateLimitError +(class)”>RateLimitError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::RelocationBatchEntryError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/RelocationBatchEntryError.html” +title=“DropboxApi::Errors::RelocationBatchEntryError +(class)”>RelocationBatchEntryError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::RelocationError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/RelocationError.html” +title=“DropboxApi::Errors::RelocationError +(class)”>RelocationError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::RestoreError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/RestoreError.html” +title=“DropboxApi::Errors::RestoreError +(class)”>RestoreError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::RestrictedContentError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/RestrictedContentError.html” +title=“DropboxApi::Errors::RestrictedContentError +(class)”>RestrictedContentError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::RevokeSharedLinkError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/RevokeSharedLinkError.html” +title=“DropboxApi::Errors::RevokeSharedLinkError +(class)”>RevokeSharedLinkError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SaveCopyReferenceError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SaveCopyReferenceError.html” +title=“DropboxApi::Errors::SaveCopyReferenceError +(class)”>SaveCopyReferenceError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SaveUrlError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SaveUrlError.html” +title=“DropboxApi::Errors::SaveUrlError +(class)”>SaveUrlError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SearchError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SearchError.html” +title=“DropboxApi::Errors::SearchError +(class)”>SearchError</a></span> &lt; BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SettingsError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SettingsError.html” +title=“DropboxApi::Errors::SettingsError +(class)”>SettingsError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::ShareFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/ShareFolderError.html” +title=“DropboxApi::Errors::ShareFolderError +(class)”>ShareFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SharePathError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SharePathError.html” +title=“DropboxApi::Errors::SharePathError +(class)”>SharePathError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SharedFolderAccessError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SharedFolderAccessError.html” +title=“DropboxApi::Errors::SharedFolderAccessError +(class)”>SharedFolderAccessError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SharedLinkAccessDeniedError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SharedLinkAccessDeniedError.html” +title=“DropboxApi::Errors::SharedLinkAccessDeniedError +(class)”>SharedLinkAccessDeniedError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SharedLinkAlreadyExistsError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SharedLinkAlreadyExistsError.html” +title=“DropboxApi::Errors::SharedLinkAlreadyExistsError +(class)”>SharedLinkAlreadyExistsError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SharedLinkError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SharedLinkError.html” +title=“DropboxApi::Errors::SharedLinkError +(class)”>SharedLinkError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SharedLinkMalformedError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SharedLinkMalformedError.html” +title=“DropboxApi::Errors::SharedLinkMalformedError +(class)”>SharedLinkMalformedError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SharedLinkNotFoundError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SharedLinkNotFoundError.html” +title=“DropboxApi::Errors::SharedLinkNotFoundError +(class)”>SharedLinkNotFoundError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SharingFileAccessError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SharingFileAccessError.html” +title=“DropboxApi::Errors::SharingFileAccessError +(class)”>SharingFileAccessError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::SharingUserError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/SharingUserError.html” +title=“DropboxApi::Errors::SharingUserError +(class)”>SharingUserError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::TeamFolderError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/TeamFolderError.html” +title=“DropboxApi::Errors::TeamFolderError +(class)”>TeamFolderError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html” +title=“DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError +(class)”>TeamPolicyDisallowsMemberPolicyError</a></span> +&lt; BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::ThumbnailBatchError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/ThumbnailBatchError.html” +title=“DropboxApi::Errors::ThumbnailBatchError +(class)”>ThumbnailBatchError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::ThumbnailError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/ThumbnailError.html” +title=“DropboxApi::Errors::ThumbnailError +(class)”>ThumbnailError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::TooManyFilesError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/TooManyFilesError.html” +title=“DropboxApi::Errors::TooManyFilesError +(class)”>TooManyFilesError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::TooManyMembersError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/TooManyMembersError.html” +title=“DropboxApi::Errors::TooManyMembersError +(class)”>TooManyMembersError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::TooManyPendingInvitesError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/TooManyPendingInvitesError.html” +title=“DropboxApi::Errors::TooManyPendingInvitesError +(class)”>TooManyPendingInvitesError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::TooManyRequestsError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/TooManyRequestsError.html” +title=“DropboxApi::Errors::TooManyRequestsError +(class)”>TooManyRequestsError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::TooManySharedFolderTargetsError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/TooManySharedFolderTargetsError.html” +title=“DropboxApi::Errors::TooManySharedFolderTargetsError +(class)”>TooManySharedFolderTargetsError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::TooManyWriteOperationsError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/TooManyWriteOperationsError.html” +title=“DropboxApi::Errors::TooManyWriteOperationsError +(class)”>TooManyWriteOperationsError</a></span> &lt; +TooManyRequestsError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::UnmountedError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/UnmountedError.html” +title=“DropboxApi::Errors::UnmountedError +(class)”>UnmountedError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::UnshareFileError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/UnshareFileError.html” +title=“DropboxApi::Errors::UnshareFileError +(class)”>UnshareFileError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::UnsupportedContentError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/UnsupportedContentError.html” +title=“DropboxApi::Errors::UnsupportedContentError +(class)”>UnsupportedContentError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::UnsupportedExtensionError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/UnsupportedExtensionError.html” +title=“DropboxApi::Errors::UnsupportedExtensionError +(class)”>UnsupportedExtensionError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::UnsupportedImageError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/UnsupportedImageError.html” +title=“DropboxApi::Errors::UnsupportedImageError +(class)”>UnsupportedImageError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::UnsupportedLinkTypeError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/UnsupportedLinkTypeError.html” +title=“DropboxApi::Errors::UnsupportedLinkTypeError +(class)”>UnsupportedLinkTypeError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::UnverifiedDropboxId' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/UnverifiedDropboxId.html” +title=“DropboxApi::Errors::UnverifiedDropboxId +(class)”>UnverifiedDropboxId</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::UploadError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/UploadError.html” +title=“DropboxApi::Errors::UploadError +(class)”>UploadError</a></span> &lt; BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::UploadSessionFinishError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/UploadSessionFinishError.html” +title=“DropboxApi::Errors::UploadSessionFinishError +(class)”>UploadSessionFinishError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::UploadSessionLookupError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/UploadSessionLookupError.html” +title=“DropboxApi::Errors::UploadSessionLookupError +(class)”>UploadSessionLookupError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::UploadSessionOffsetError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/UploadSessionOffsetError.html” +title=“DropboxApi::Errors::UploadSessionOffsetError +(class)”>UploadSessionOffsetError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::UploadWriteFailedError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/UploadWriteFailedError.html” +title=“DropboxApi::Errors::UploadWriteFailedError +(class)”>UploadWriteFailedError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::WriteConflictError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/WriteConflictError.html” +title=“DropboxApi::Errors::WriteConflictError +(class)”>WriteConflictError</a></span> &lt; +BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li><li +id='object_DropboxApi::Errors::WriteError' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Errors/WriteError.html” +title=“DropboxApi::Errors::WriteError +(class)”>WriteError</a></span> &lt; BasicError<small +class='search_info'>DropboxApi::Errors</small></div></li></ul></li><li +id='object_DropboxApi::Metadata' class='collapsed +odd'><div class='item' +style='padding-left:45px'><a +class='toggle'></a> <span +class='object_link'><a href=“DropboxApi/Metadata.html” +title=“DropboxApi::Metadata +(module)”>Metadata</a></span><small +class='search_info'>DropboxApi</small></div><ul><li +id='object_DropboxApi::Metadata::AccessLevel' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/AccessLevel.html” +title=“DropboxApi::Metadata::AccessLevel +(class)”>AccessLevel</a></span> &lt; Tag<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::AddFileMemberResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/AddFileMemberResult.html” +title=“DropboxApi::Metadata::AddFileMemberResult +(class)”>AddFileMemberResult</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::AddMember' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/AddMember.html” +title=“DropboxApi::Metadata::AddMember +(class)”>AddMember</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::Base' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a href=“DropboxApi/Metadata/Base.html” +title=“DropboxApi::Metadata::Base (class)”>Base</a></span> +&lt; Object<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::BasicAccount' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/BasicAccount.html” +title=“DropboxApi::Metadata::BasicAccount +(class)”>BasicAccount</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::CommitInfo' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/CommitInfo.html” +title=“DropboxApi::Metadata::CommitInfo +(class)”>CommitInfo</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::Deleted' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/Deleted.html” +title=“DropboxApi::Metadata::Deleted +(class)”>Deleted</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::Dimensions' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/Dimensions.html” +title=“DropboxApi::Metadata::Dimensions +(class)”>Dimensions</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::Field' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a href=“DropboxApi/Metadata/Field.html” +title=“DropboxApi::Metadata::Field (class)”>Field</a></span> +&lt; Object<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::File' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a href=“DropboxApi/Metadata/File.html” +title=“DropboxApi::Metadata::File (class)”>File</a></span> +&lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::FileCategoriesList' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/FileCategoriesList.html” +title=“DropboxApi::Metadata::FileCategoriesList +(class)”>FileCategoriesList</a></span> &lt; +Array<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::FileCategory' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/FileCategory.html” +title=“DropboxApi::Metadata::FileCategory +(class)”>FileCategory</a></span> &lt; Tag<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::FileExtensionsList' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/FileExtensionsList.html” +title=“DropboxApi::Metadata::FileExtensionsList +(class)”>FileExtensionsList</a></span> &lt; +Array<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::FileLinkMetadata' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/FileLinkMetadata.html” +title=“DropboxApi::Metadata::FileLinkMetadata +(class)”>FileLinkMetadata</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::FileMemberAction' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/FileMemberAction.html” +title=“DropboxApi::Metadata::FileMemberAction +(class)”>FileMemberAction</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::FileRequest' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/FileRequest.html” +title=“DropboxApi::Metadata::FileRequest +(class)”>FileRequest</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::FileStatus' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/FileStatus.html” +title=“DropboxApi::Metadata::FileStatus +(class)”>FileStatus</a></span> &lt; Tag<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::Folder' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a href=“DropboxApi/Metadata/Folder.html” +title=“DropboxApi::Metadata::Folder +(class)”>Folder</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::FolderLinkMetadata' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/FolderLinkMetadata.html” +title=“DropboxApi::Metadata::FolderLinkMetadata +(class)”>FolderLinkMetadata</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::FolderSharingInfo' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/FolderSharingInfo.html” +title=“DropboxApi::Metadata::FolderSharingInfo +(class)”>FolderSharingInfo</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::LinkPermissions' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/LinkPermissions.html” +title=“DropboxApi::Metadata::LinkPermissions +(class)”>LinkPermissions</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::Location' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/Location.html” +title=“DropboxApi::Metadata::Location +(class)”>Location</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::MediaInfo' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/MediaInfo.html” +title=“DropboxApi::Metadata::MediaInfo +(class)”>MediaInfo</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::MediaMetadata' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/MediaMetadata.html” +title=“DropboxApi::Metadata::MediaMetadata +(class)”>MediaMetadata</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::Member' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a href=“DropboxApi/Metadata/Member.html” +title=“DropboxApi::Metadata::Member +(class)”>Member</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::MemberAction' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/MemberAction.html” +title=“DropboxApi::Metadata::MemberAction +(class)”>MemberAction</a></span> &lt; Tag<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::MemberActionList' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/MemberActionList.html” +title=“DropboxApi::Metadata::MemberActionList +(class)”>MemberActionList</a></span> &lt; Array<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::MemberPermission' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/MemberPermission.html” +title=“DropboxApi::Metadata::MemberPermission +(class)”>MemberPermission</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::MemberPermissionList' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/MemberPermissionList.html” +title=“DropboxApi::Metadata::MemberPermissionList +(class)”>MemberPermissionList</a></span> &lt; +Array<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::MetadataV2' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/MetadataV2.html” +title=“DropboxApi::Metadata::MetadataV2 +(class)”>MetadataV2</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::Name' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a href=“DropboxApi/Metadata/Name.html” +title=“DropboxApi::Metadata::Name (class)”>Name</a></span> +&lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::NamespaceId' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/NamespaceId.html” +title=“DropboxApi::Metadata::NamespaceId +(class)”>NamespaceId</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::ParentFolderAccessInfo' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/ParentFolderAccessInfo.html” +title=“DropboxApi::Metadata::ParentFolderAccessInfo +(class)”>ParentFolderAccessInfo</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::PhotoMetadata' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/PhotoMetadata.html” +title=“DropboxApi::Metadata::PhotoMetadata +(class)”>PhotoMetadata</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::Resource' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/Resource.html” +title=“DropboxApi::Metadata::Resource +(class)”>Resource</a></span> &lt; Object<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::RootInfo' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/RootInfo.html” +title=“DropboxApi::Metadata::RootInfo +(class)”>RootInfo</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::SearchMatchFieldOptions' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/SearchMatchFieldOptions.html” +title=“DropboxApi::Metadata::SearchMatchFieldOptions +(class)”>SearchMatchFieldOptions</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::SearchMatchTypeV2' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/SearchMatchTypeV2.html” +title=“DropboxApi::Metadata::SearchMatchTypeV2 +(class)”>SearchMatchTypeV2</a></span> &lt; Tag<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::SearchMatchV2' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/SearchMatchV2.html” +title=“DropboxApi::Metadata::SearchMatchV2 +(class)”>SearchMatchV2</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::SearchOptions' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/SearchOptions.html” +title=“DropboxApi::Metadata::SearchOptions +(class)”>SearchOptions</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::SearchOrderBy' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/SearchOrderBy.html” +title=“DropboxApi::Metadata::SearchOrderBy +(class)”>SearchOrderBy</a></span> &lt; Tag<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::SharedFolder' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/SharedFolder.html” +title=“DropboxApi::Metadata::SharedFolder +(class)”>SharedFolder</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::SharedFolderPolicy' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/SharedFolderPolicy.html” +title=“DropboxApi::Metadata::SharedFolderPolicy +(class)”>SharedFolderPolicy</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::SharedLink' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/SharedLink.html” +title=“DropboxApi::Metadata::SharedLink +(class)”>SharedLink</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::SharedLinkMetadata' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/SharedLinkMetadata.html” +title=“DropboxApi::Metadata::SharedLinkMetadata +(class)”>SharedLinkMetadata</a></span> &lt; Object<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::SpaceAllocation' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/SpaceAllocation.html” +title=“DropboxApi::Metadata::SpaceAllocation +(class)”>SpaceAllocation</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::SpaceUsage' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/SpaceUsage.html” +title=“DropboxApi::Metadata::SpaceUsage +(class)”>SpaceUsage</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::Tag' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a href=“DropboxApi/Metadata/Tag.html” +title=“DropboxApi::Metadata::Tag (class)”>Tag</a></span> +&lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::Team' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a href=“DropboxApi/Metadata/Team.html” +title=“DropboxApi::Metadata::Team (class)”>Team</a></span> +&lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::TeamMemberInfo' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/TeamMemberInfo.html” +title=“DropboxApi::Metadata::TeamMemberInfo +(class)”>TeamMemberInfo</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::TeamRootInfo' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/TeamRootInfo.html” +title=“DropboxApi::Metadata::TeamRootInfo +(class)”>TeamRootInfo</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::ThumbnailBatchResultData' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/ThumbnailBatchResultData.html” +title=“DropboxApi::Metadata::ThumbnailBatchResultData +(class)”>ThumbnailBatchResultData</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::ThumbnailBatchResultEntry' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/ThumbnailBatchResultEntry.html” +title=“DropboxApi::Metadata::ThumbnailBatchResultEntry +(class)”>ThumbnailBatchResultEntry</a></span> &lt; Object<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::UploadSessionCursor' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/UploadSessionCursor.html” +title=“DropboxApi::Metadata::UploadSessionCursor +(class)”>UploadSessionCursor</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::UserRootInfo' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/UserRootInfo.html” +title=“DropboxApi::Metadata::UserRootInfo +(class)”>UserRootInfo</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::VideoMetadata' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/VideoMetadata.html” +title=“DropboxApi::Metadata::VideoMetadata +(class)”>VideoMetadata</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li><li +id='object_DropboxApi::Metadata::WriteMode' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Metadata/WriteMode.html” +title=“DropboxApi::Metadata::WriteMode +(class)”>WriteMode</a></span> &lt; Base<small +class='search_info'>DropboxApi::Metadata</small></div></li></ul></li><li +id='object_DropboxApi::MiddleWare' class='collapsed +even'><div class='item' +style='padding-left:45px'><a +class='toggle'></a> <span +class='object_link'><a href=“DropboxApi/MiddleWare.html” +title=“DropboxApi::MiddleWare +(module)”>MiddleWare</a></span><small +class='search_info'>DropboxApi</small></div><ul><li +id='object_DropboxApi::MiddleWare::DecodeResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/MiddleWare/DecodeResult.html” +title=“DropboxApi::MiddleWare::DecodeResult +(class)”>DecodeResult</a></span> &lt; +Middleware<small +class='search_info'>DropboxApi::MiddleWare</small></div></li><li +id='object_DropboxApi::MiddleWare::PathRoot' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/MiddleWare/PathRoot.html” +title=“DropboxApi::MiddleWare::PathRoot +(class)”>PathRoot</a></span> &lt; Middleware<small +class='search_info'>DropboxApi::MiddleWare</small></div></li><li +id='object_DropboxApi::MiddleWare::Stack' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/MiddleWare/Stack.html” +title=“DropboxApi::MiddleWare::Stack +(class)”>Stack</a></span> &lt; Object<small +class='search_info'>DropboxApi::MiddleWare</small></div></li></ul></li><li +id='object_DropboxApi::OptionsValidator' class='collapsed +odd'><div class='item' +style='padding-left:45px'><span +class='object_link'><a +href=“DropboxApi/OptionsValidator.html” title=“DropboxApi::OptionsValidator +(module)”>OptionsValidator</a></span><small +class='search_info'>DropboxApi</small></div></li><li +id='object_DropboxApi::ResultBuilder' class='collapsed +even'><div class='item' +style='padding-left:45px'><span +class='object_link'><a href=“DropboxApi/ResultBuilder.html” +title=“DropboxApi::ResultBuilder +(class)”>ResultBuilder</a></span> &lt; Object<small +class='search_info'>DropboxApi</small></div></li><li +id='object_DropboxApi::Results' class='collapsed +odd'><div class='item' +style='padding-left:45px'><a +class='toggle'></a> <span +class='object_link'><a href=“DropboxApi/Results.html” +title=“DropboxApi::Results +(module)”>Results</a></span><small +class='search_info'>DropboxApi</small></div><ul><li +id='object_DropboxApi::Results::AddFileMemberResultList' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/AddFileMemberResultList.html” +title=“DropboxApi::Results::AddFileMemberResultList +(class)”>AddFileMemberResultList</a></span> &lt; +Array<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::Base' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a href=“DropboxApi/Results/Base.html” +title=“DropboxApi::Results::Base (class)”>Base</a></span> +&lt; Object<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::BasicAccountBatch' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/BasicAccountBatch.html” +title=“DropboxApi::Results::BasicAccountBatch +(class)”>BasicAccountBatch</a></span> &lt; +Array<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::CopyBatchResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/CopyBatchResult.html” +title=“DropboxApi::Results::CopyBatchResult +(class)”>CopyBatchResult</a></span> &lt; Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::CreateFolderBatchResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/CreateFolderBatchResult.html” +title=“DropboxApi::Results::CreateFolderBatchResult +(class)”>CreateFolderBatchResult</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::CreateFolderBatchResultEntry' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/CreateFolderBatchResultEntry.html” +title=“DropboxApi::Results::CreateFolderBatchResultEntry +(class)”>CreateFolderBatchResultEntry</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::DeleteBatchResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/DeleteBatchResult.html” +title=“DropboxApi::Results::DeleteBatchResult +(class)”>DeleteBatchResult</a></span> &lt; Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::DeleteBatchResultEntry' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/DeleteBatchResultEntry.html” +title=“DropboxApi::Results::DeleteBatchResultEntry +(class)”>DeleteBatchResultEntry</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::GetCopyReferenceResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/GetCopyReferenceResult.html” +title=“DropboxApi::Results::GetCopyReferenceResult +(class)”>GetCopyReferenceResult</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::GetTemporaryLinkResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/GetTemporaryLinkResult.html” +title=“DropboxApi::Results::GetTemporaryLinkResult +(class)”>GetTemporaryLinkResult</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::GetThumbnailBatchResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/GetThumbnailBatchResult.html” +title=“DropboxApi::Results::GetThumbnailBatchResult +(class)”>GetThumbnailBatchResult</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::ListFolderGetLatestCursorResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/ListFolderGetLatestCursorResult.html” +title=“DropboxApi::Results::ListFolderGetLatestCursorResult +(class)”>ListFolderGetLatestCursorResult</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::ListFolderLongpollResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/ListFolderLongpollResult.html” +title=“DropboxApi::Results::ListFolderLongpollResult +(class)”>ListFolderLongpollResult</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::ListFolderResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/ListFolderResult.html” +title=“DropboxApi::Results::ListFolderResult +(class)”>ListFolderResult</a></span> &lt; Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::ListRevisionsResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/ListRevisionsResult.html” +title=“DropboxApi::Results::ListRevisionsResult +(class)”>ListRevisionsResult</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::ListSharedLinksResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/ListSharedLinksResult.html” +title=“DropboxApi::Results::ListSharedLinksResult +(class)”>ListSharedLinksResult</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::RelocationBatchResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/RelocationBatchResult.html” +title=“DropboxApi::Results::RelocationBatchResult +(class)”>RelocationBatchResult</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::RelocationBatchResultEntry' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/RelocationBatchResultEntry.html” +title=“DropboxApi::Results::RelocationBatchResultEntry +(class)”>RelocationBatchResultEntry</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::SaveCopyReferenceResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/SaveCopyReferenceResult.html” +title=“DropboxApi::Results::SaveCopyReferenceResult +(class)”>SaveCopyReferenceResult</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::SaveUrlJobStatus' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/SaveUrlJobStatus.html” +title=“DropboxApi::Results::SaveUrlJobStatus +(class)”>SaveUrlJobStatus</a></span> &lt; Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::SaveUrlResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/SaveUrlResult.html” +title=“DropboxApi::Results::SaveUrlResult +(class)”>SaveUrlResult</a></span> &lt; Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::Search' +class='collapsed'><div class='item' +style='padding-left:60px'><a +class='toggle'></a> <span +class='object_link'><a href=“DropboxApi/Results/Search.html” +title=“DropboxApi::Results::Search +(module)”>Search</a></span><small +class='search_info'>DropboxApi::Results</small></div><ul><li +id='object_DropboxApi::Results::Search::Match' +class='collapsed'><div class='item' +style='padding-left:75px'><span +class='object_link'><a +href=“DropboxApi/Results/Search/Match.html” +title=“DropboxApi::Results::Search::Match +(class)”>Match</a></span> &lt; Object<small +class='search_info'>DropboxApi::Results::Search</small></div></li></ul></li><li +id='object_DropboxApi::Results::SearchV2Result' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/SearchV2Result.html” +title=“DropboxApi::Results::SearchV2Result +(class)”>SearchV2Result</a></span> &lt; Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::ShareFolderLaunch' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/ShareFolderLaunch.html” +title=“DropboxApi::Results::ShareFolderLaunch +(class)”>ShareFolderLaunch</a></span> &lt; Object<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::SharedFileMembers' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/SharedFileMembers.html” +title=“DropboxApi::Results::SharedFileMembers +(class)”>SharedFileMembers</a></span> &lt; Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::SharedFolderMembers' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/SharedFolderMembers.html” +title=“DropboxApi::Results::SharedFolderMembers +(class)”>SharedFolderMembers</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::UploadSessionStart' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/UploadSessionStart.html” +title=“DropboxApi::Results::UploadSessionStart +(class)”>UploadSessionStart</a></span> &lt; +Base<small +class='search_info'>DropboxApi::Results</small></div></li><li +id='object_DropboxApi::Results::VoidResult' +class='collapsed'><div class='item' +style='padding-left:60px'><span +class='object_link'><a +href=“DropboxApi/Results/VoidResult.html” +title=“DropboxApi::Results::VoidResult +(class)”>VoidResult</a></span> &lt; Base<small +class='search_info'>DropboxApi::Results</small></div></li></ul></li></ul></li><li +id='object_DropboxScaffoldBuilder' class='even'><div +class='item' style='padding-left:30px'><span +class='object_link'><a href=“DropboxScaffoldBuilder.html” +title=“DropboxScaffoldBuilder +(class)”>DropboxScaffoldBuilder</a></span> &lt; Object<small +class='search_info'>Top Level +Namespace</small></div></li>

+ +
    </ul>
+  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/css/common_css.html b/doc/docs/css/common_css.html new file mode 100644 index 00000000..988e289e --- /dev/null +++ b/doc/docs/css/common_css.html @@ -0,0 +1,711 @@ + + + + + + +common.css - RDoc Documentation + + + + + + + + + + + + + + +
+ +

.test_code {

+ +
font-size: 13px;
+line-height: normal;
+ +

} .showSource {

+ +
font-size: 13px;
+ +

}

+
+ + + + + diff --git a/doc/docs/css/full_list_css.html b/doc/docs/css/full_list_css.html new file mode 100644 index 00000000..86bb966e --- /dev/null +++ b/doc/docs/css/full_list_css.html @@ -0,0 +1,757 @@ + + + + + + +full_list.css - RDoc Documentation + + + + + + + + + + + + + + +
+ +

body {

+ +
margin: 0;
+font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+font-size: 13px;
+height: 101%;
+overflow-x: hidden;
+background: #fafafa;
+ +

}

+ +

h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; } +.clear { clear: both; } .fixed_header { position: fixed; background: fff; +width: 100%; padding-bottom: 10px; margin-top: 0; top: 0; z-index: 9999; +height: 70px; } search { position: absolute; right: 5px; top: 9px; +padding-left: 24px; } content.insearch search, content.insearch noresults { +background: +url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) +no-repeat center left; } full_list { padding: 0; list-style: none; +margin-left: 0; margin-top: 80px; font-size: 1.1em; } full_list ul { +padding: 0; } full_list li { padding: 0; margin: 0; list-style: none; } +full_list li .item { padding: 5px 5px 5px 12px; } noresults { padding: 7px +12px; background: fff; } content.insearch noresults { margin-left: 7px; } +li.collapsed ul { display: none; } li a.toggle { cursor: default; position: +relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: +9px; margin-left: -10px; display: block; float: left; background: +url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) +no-repeat bottom left; } li.collapsed a.toggle { opacity: 0.5; cursor: +default; background-position: top left; } li { color: #888; cursor: +pointer; } li.deprecated { text-decoration: line-through; font-style: +italic; } li.odd { background: f0f0f0; } li.even { background: fafafa; } +.item:hover { background: ddd; } li small:before { content: “(”; } li +small:after { content: “)”; } li small.search_info { display: none; } a, +a:visited { text-decoration: none; color: #05a; } li.clicked > .item { +background: #05a; color: ccc; } li.clicked > .item a, li.clicked > +.item a:visited { color: eee; } li.clicked > .item a.toggle { opacity: +0.5; background-position: bottom right; } li.collapsed.clicked a.toggle { +background-position: top right; } search input { border: 1px solid bbb; +border-radius: 3px; } full_list_nav { margin-left: 10px; font-size: 0.9em; +display: block; color: aaa; } full_list_nav a, nav a:visited { color: #358; +} full_list_nav a:hover { background: transparent; color: #5af; } +full_list_nav span:after { content: ' | '; } full_list_nav +span:last-child:after { content: ''; }

+ +

content h1 { margin-top: 0; } li { white-space: nowrap; cursor: normal; } +li small { display: block; font-size: 0.8em; } li small:before { content: +“”; } li small:after { content: “”; } li small.search_info { display: none; +} search { width: 170px; position: static; margin: 3px; margin-left: 10px; +font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; } +content.insearch search { background-position: center right; } search input +{ width: 110px; }

+ +

full_list.insearch ul { display: block; } full_list.insearch .item { +display: none; } full_list.insearch .found { display: block; padding-left: +11px !important; } full_list.insearch li a.toggle { display: none; } +full_list.insearch li small.search_info { display: block; }

+
+ + + + + diff --git a/doc/docs/css/style_css.html b/doc/docs/css/style_css.html new file mode 100644 index 00000000..9b9ed150 --- /dev/null +++ b/doc/docs/css/style_css.html @@ -0,0 +1,1225 @@ + + + + + + +style.css - RDoc Documentation + + + + + + + + + + + + + + +
+ +

html {

+ +
width: 100%;
+height: 100%;
+ +

} body {

+ +
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+font-size: 13px;
+width: 100%;
+margin: 0;
+padding: 0;
+display: flex;
+display: -webkit-flex;
+display: -ms-flexbox;
+ +

}

+ +

nav {

+ +
position: relative;
+width: 100%;
+height: 100%;
+border: 0;
+border-right: 1px dotted #eee;
+overflow: auto;
+ +

} .nav_wrap {

+ +
margin: 0;
+padding: 0;
+width: 20%;
+height: 100%;
+position: relative;
+display: flex;
+display: -webkit-flex;
+display: -ms-flexbox;
+flex-shrink: 0;
+-webkit-flex-shrink: 0;
+-ms-flex: 1 0;
+ +

} resizer {

+ +
position: absolute;
+right: -5px;
+top: 0;
+width: 10px;
+height: 100%;
+cursor: col-resize;
+z-index: 9999;
+ +

} main {

+ +
flex: 5 1;
+-webkit-flex: 5 1;
+-ms-flex: 5 1;
+outline: none;
+position: relative;
+background: #fff;
+padding: 1.2em;
+padding-top: 0.2em;
+box-sizing: border-box;
+ +

}

+ +

@media (max-width: 920px) {

+ +
.nav_wrap { width: 100%; top: 0; right: 0; overflow: visible; position: absolute; }
+#resizer { display: none; }
+#nav {
+  z-index: 9999;
+  background: #fff;
+  display: none;
+  position: absolute;
+  top: 40px;
+  right: 12px;
+  width: 500px;
+  max-width: 80%;
+  height: 80%;
+  overflow-y: scroll;
+  border: 1px solid #999;
+  border-collapse: collapse;
+  box-shadow: -7px 5px 25px #aaa;
+  border-radius: 2px;
+}
+ +

}

+ +

@media (min-width: 920px) {

+ +
body { height: 100%; overflow: hidden; }
+#main { height: 100%; overflow: auto; }
+#search { display: none; }
+ +

}

+ +

main img { max-width: 100%; } h1 { font-size: 25px; margin: 1em 0 0.5em; +padding-top: 4px; border-top: 1px dotted d5d5d5; } h1.noborder { +border-top: 0px; margin-top: 0; padding-top: 4px; } h1.title { +margin-bottom: 10px; } h1.alphaindex { margin-top: 0; font-size: 22px; } h2 +{

+ +
padding: 0;
+padding-bottom: 3px;
+border-bottom: 1px #aaa solid;
+font-size: 1.4em;
+margin: 1.8em 0 0.5em;
+position: relative;
+ +

} h2 small { font-weight: normal; font-size: 0.7em; display: inline; +position: absolute; right: 0; } h2 small a {

+ +
display: block;
+height: 20px;
+border: 1px solid #aaa;
+border-bottom: 0;
+border-top-left-radius: 5px;
+background: #f8f8f8;
+position: relative;
+padding: 2px 7px;
+ +

} .clear { clear: both; } .inline { display: inline; } .inline +p:first-child { display: inline; } .docstring, .tags, filecontents { +font-size: 15px; line-height: 1.5145em; } .docstring p > code, +.docstring p > tt, .tags p > code, .tags p > tt {

+ +
color: #c7254e; background: #f9f2f4; padding: 2px 4px; font-size: 1em;
+border-radius: 4px;
+ +

} .docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; +border: 0; border-bottom: 1px dotted bbb; } .docstring h1 { font-size: +1.2em; } .docstring h2 { font-size: 1.1em; } .docstring h3, .docstring h4 { +font-size: 1em; border-bottom: 0; padding-top: 10px; } .summary_desc +.object_link a, .docstring .object_link a {

+ +
font-family: monospace; font-size: 1.05em;
+color: #05a; background: #EDF4FA; padding: 2px 4px; font-size: 1em;
+border-radius: 4px;
+ +

} .rdoc-term { padding-right: 25px; font-weight: bold; } .rdoc-list p { +margin: 0; padding: 0; margin-bottom: 4px; } .summary_desc pre.code +.object_link a, .docstring pre.code .object_link a {

+ +
padding: 0px; background: inherit; color: inherit; border-radius: inherit;
+ +

}

+ +
style for <table>
+ +

filecontents table, .docstring table { border-collapse: collapse; } +filecontents table th, filecontents table td, .docstring table th, +.docstring table td { border: 1px solid ccc; padding: 8px; padding-right: +17px; } filecontents table tr:nth-child(odd), .docstring table +tr:nth-child(odd) { background: eee; } filecontents table +tr:nth-child(even), .docstring table tr:nth-child(even) { background: fff; +} filecontents table th, .docstring table th { background: fff; }

+ +
style for <ul>
+ +

filecontents li > p, .docstring li > p { margin: 0px; } filecontents +ul, .docstring ul { padding-left: 20px; } /* style for <dl> */ +filecontents dl, .docstring dl { border: 1px solid ccc; } filecontents dt, +.docstring dt { background: ddd; font-weight: bold; padding: 3px 5px; } +filecontents dd, .docstring dd { padding: 5px 0px; margin-left: 18px; } +filecontents dd > p, .docstring dd > p { margin: 0px; }

+ +

.note {

+ +
color: #222;
+margin: 20px 0;
+padding: 10px;
+border: 1px solid #eee;
+border-radius: 3px;
+display: block;
+ +

} .docstring .note {

+ +
border-left-color: #ccc;
+border-left-width: 5px;
+ +

} .note.todo { background: ffffc5; border-color: ececaa; } +.note.returns_void { background: efefef; } .note.deprecated { background: +ffe5e5; border-color: e9dada; } .note.title.deprecated { background: +ffe5e5; border-color: e9dada; } .note.private { background: ffffc5; +border-color: ececaa; } .note.title { padding: 3px 6px; font-size: 0.9em; +font-family: “Lucida Sans”, “Lucida Grande”, Verdana, Arial, sans-serif; +display: inline; } .summary_signature + .note.title { margin-left: 7px; } +h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; +position: relative; top: -3px; text-transform: capitalize; } .note.title { +background: efefef; } .note.title.constructor { color: fff; background: +#6a98d6; border-color: #6689d6; } .note.title.writeonly { color: fff; +background: #45a638; border-color: #2da31d; } .note.title.readonly { color: +fff; background: #6a98d6; border-color: #6689d6; } .note.title.private { +background: d5d5d5; border-color: c5c5c5; } .note.title.not_defined_here { +background: transparent; border: none; font-style: italic; } .discussion +.note { margin-top: 6px; } .discussion .note:first-child { margin-top: 0; }

+ +

h3.inherited {

+ +
font-style: italic;
+font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+font-weight: normal;
+padding: 0;
+margin: 0;
+margin-top: 12px;
+margin-bottom: 3px;
+font-size: 13px;
+ +

} p.inherited {

+ +
padding: 0;
+margin: 0;
+margin-left: 25px;
+ +

}

+ +

.box_info dl {

+ +
margin: 0;
+border: 0;
+width: 100%;
+font-size: 1em;
+display: flex;
+display: -webkit-flex;
+display: -ms-flexbox;
+ +

} .box_info dl dt {

+ +
flex-shrink: 0;
+-webkit-flex-shrink: 1;
+-ms-flex-shrink: 1;
+width: 100px;
+text-align: right;
+font-weight: bold;
+border: 1px solid #aaa;
+border-width: 1px 0px 0px 1px;
+padding: 6px 0;
+padding-right: 10px;
+ +

} .box_info dl dd {

+ +
flex-grow: 1;
+-webkit-flex-grow: 1;
+-ms-flex: 1;
+max-width: 420px;
+padding: 6px 0;
+padding-right: 20px;
+border: 1px solid #aaa;
+border-width: 1px 1px 0 0;
+overflow: hidden;
+position: relative;
+ +

} .box_info dl:last-child > * {

+ +
border-bottom: 1px solid #aaa;
+ +

} .box_info dl:nth-child(odd) > * { background: eee; } .box_info +dl:nth-child(even) > * { background: fff; } .box_info dl > * { +margin: 0; }

+ +

ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; } +.index_inline_list { padding-left: 0; font-size: 1.1em; }

+ +

.index_inline_list li {

+ +
list-style: none;
+display: inline-block;
+padding: 0 12px;
+line-height: 30px;
+margin-bottom: 5px;
+ +

}

+ +

dl.constants { margin-left: 10px; } dl.constants dt { font-weight: bold; +font-size: 1.1em; margin-bottom: 5px; } dl.constants.compact dt { display: +inline-block; font-weight: normal } dl.constants dd { width: 75%; +white-space: pre; font-family: monospace; margin-bottom: 18px; } +dl.constants .docstring .note:first-child { margin-top: 5px; }

+ +

.summary_desc {

+ +
margin-left: 32px;
+display: block;
+font-family: sans-serif;
+font-size: 1.1em;
+margin-top: 8px;
+line-height: 1.5145em;
+margin-bottom: 0.8em;
+ +

} .summary_desc tt { font-size: 0.9em; } dl.constants .note { padding: 2px +6px; padding-right: 12px; margin-top: 6px; } dl.constants .docstring { +margin-left: 32px; font-size: 0.9em; font-weight: normal; } dl.constants +.tags { padding-left: 32px; font-size: 0.9em; line-height: 0.8em; } +dl.constants .discussion *:first-child { margin-top: 0; } dl.constants +.discussion *:last-child { margin-bottom: 0; }

+ +

.method_details { border-top: 1px dotted ccc; margin-top: 25px; +padding-top: 0; } .method_details.first { border: 0; margin-top: 5px; } +.method_details.first h3.signature { margin-top: 1em; } p.signature, +h3.signature {

+ +
font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace;
+padding: 6px 10px; margin-top: 1em;
+background: #E8F4FF; border: 1px solid #d8d8e5; border-radius: 5px;
+ +

} p.signature tt, h3.signature tt { font-family: Monaco, Consolas, Courier, +monospace; } p.signature .overload, h3.signature .overload { display: +block; } p.signature .extras, h3.signature .extras { font-weight: normal; +font-family: sans-serif; color: #444; font-size: 1em; } p.signature +.not_defined_here, h3.signature .not_defined_here, p.signature .aliases, +h3.signature .aliases { display: block; font-weight: normal; font-size: +0.9em; font-family: sans-serif; margin-top: 0px; color: #555; } p.signature +.aliases .names, h3.signature .aliases .names { font-family: Monaco, +Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: +1.2em; }

+ +

.tags .tag_title { font-size: 1.05em; margin-bottom: 0; font-weight: bold; +} .tags .tag_title tt { color: initial; padding: initial; background: +initial; } .tags ul { margin-top: 5px; padding-left: 30px; list-style: +square; } .tags ul li { margin-bottom: 3px; } .tags ul .name { font-family: +monospace; font-weight: bold; } .tags ul .note { padding: 3px 6px; } .tags +{ margin-bottom: 12px; }

+ +

.tags .examples .tag_title { margin-bottom: 10px; font-weight: bold; } +.tags .examples .inline p { padding: 0; margin: 0; font-weight: bold; +font-size: 1em; } .tags .examples .inline p:before { content: “▸”; +font-size: 1em; margin-right: 5px; }

+ +

.tags .overload .overload_item { list-style: none; margin-bottom: 25px; } +.tags .overload .overload_item .signature {

+ +
padding: 2px 8px;
+background: #F1F8FF; border: 1px solid #d8d8e5; border-radius: 3px;
+ +

} .tags .overload .signature { margin-left: -15px; font-family: monospace; +display: block; font-size: 1.1em; } .tags .overload .docstring { +margin-top: 15px; }

+ +

.defines { display: none; }

+ +

method_missing_details .notice.this { position: relative; top: -8px; color: +#888; padding: 0; margin: 0; }

+ +

.showSource { font-size: 0.9em; } .showSource a, .showSource a:visited { +text-decoration: none; color: #666; }

+ +

content a, content a:visited { text-decoration: none; color: #05a; } +content a:hover { background: ffffa5; }

+ +

ul.summary {

+ +
list-style: none;
+font-family: monospace;
+font-size: 1em;
+line-height: 1.5em;
+padding-left: 0px;
+ +

} ul.summary a, ul.summary a:visited {

+ +
text-decoration: none; font-size: 1.1em;
+ +

} ul.summary li { margin-bottom: 5px; } .summary_signature { padding: 4px +8px; background: f8f8f8; border: 1px solid f0f0f0; border-radius: 5px; } +.summary_signature:hover { background: #CFEBFF; border-color: #A4CCDA; +cursor: pointer; } .summary_signature.deprecated { background: ffe5e5; +border-color: e9dada; } ul.summary.compact li { display: inline-block; +margin: 0px 5px 0px 0px; line-height: 2.6em;} ul.summary.compact +.summary_signature { padding: 5px 7px; padding-right: 4px; } content +.summary_signature:hover a, content .summary_signature:hover a:visited {

+ +
background: transparent;
+color: #049;
+ +

}

+ +

p.inherited a { font-family: monospace; font-size: 0.9em; } p.inherited { +word-spacing: 5px; font-size: 1.2em; }

+ +

p.children { font-size: 1.2em; } p.children a { font-size: 0.9em; } +p.children strong { font-size: 0.8em; } p.children strong.modules { +padding-left: 5px; }

+ +

ul.fullTree { display: none; padding-left: 0; list-style: none; +margin-left: 0; margin-bottom: 10px; } ul.fullTree ul { margin-left: 0; +padding-left: 0; list-style: none; } ul.fullTree li { text-align: center; +padding-top: 18px; padding-bottom: 12px; background: +url(data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAAHtJREFUeNqMzrEJAkEURdGzuhgZbSoYWcAWoBVsB4JgZAGmphsZCZYzTQgWNCYrDN9RvMmHx+X916SUBFbo8CzD1idXrLErw1mQttgXtyrOcQ/Ny5p4Qh+2XqLYYazsPWNTiuMkRxa4vcV+evuNAUOLIx5+c2hyzv7hNQC67Q+/HHmlEwAAAABJRU5ErkJggg==) +no-repeat top center; } ul.fullTree li:first-child { padding-top: 0; +background: transparent; } ul.fullTree li:last-child { padding-bottom: 0; } +.showAll ul.fullTree { display: block; } .showAll .inheritName { display: +none; }

+ +

search { position: absolute; right: 12px; top: 0px; z-index: 9000; } search +a {

+ +
display: block; float: left;
+padding: 4px 8px; text-decoration: none; color: #05a; fill: #05a;
+border: 1px solid #d8d8e5;
+border-bottom-left-radius: 3px; border-bottom-right-radius: 3px;
+background: #F1F8FF;
+box-shadow: -1px 1px 3px #ddd;
+ +

} search a:hover { background: f5faff; color: #06b; fill: #06b; } search +a.active {

+ +
background: #568; padding-bottom: 20px; color: #fff; fill: #fff;
+border: 1px solid #457;
+border-top-left-radius: 5px; border-top-right-radius: 5px;
+ +

} search a.inactive { color: #999; fill: #999; } .inheritanceTree, +.toggleDefines {

+ +
float: right;
+border-left: 1px solid #aaa;
+position: absolute; top: 0; right: 0;
+height: 100%;
+background: #f6f6f6;
+padding: 5px;
+min-width: 55px;
+text-align: center;
+ +

}

+ +

menu { font-size: 1.3em; color: bbb; } menu .title, menu a { font-size: +0.7em; } menu .title a { font-size: 1em; } menu .title { color: #555; } +menu a, menu a:visited { color: #333; text-decoration: none; border-bottom: +1px dotted bbd; } menu a:hover { color: #05a; }

+ +

footer { margin-top: 15px; border-top: 1px solid ccc; text-align: center; +padding: 7px 0; color: #999; } footer a, footer a:visited { color: #444; +text-decoration: none; border-bottom: 1px dotted bbd; } footer a:hover { +color: #05a; }

+ +

listing ul.alpha { font-size: 1.1em; } listing ul.alpha { margin: 0; +padding: 0; padding-bottom: 10px; list-style: none; } listing ul.alpha +li.letter { font-size: 1.4em; padding-bottom: 10px; } listing ul.alpha ul { +margin: 0; padding-left: 15px; } listing ul small { color: #666; font-size: +0.7em; }

+ +

li.r1 { background: f0f0f0; } li.r2 { background: fafafa; }

+ +

content ul.summary li.deprecated .summary_signature a, content ul.summary +li.deprecated .summary_signature a:visited { text-decoration: line-through; +font-style: italic; }

+ +

toc {

+ +
position: relative;
+float: right;
+overflow-x: auto;
+right: -3px;
+margin-left: 20px;
+margin-bottom: 20px;
+padding: 20px; padding-right: 30px;
+max-width: 300px;
+z-index: 5000;
+background: #fefefe;
+border: 1px solid #ddd;
+box-shadow: -2px 2px 6px #bbb;
+ +

} toc .title { margin: 0; } toc ol { padding-left: 1.8em; } toc li { +font-size: 1.1em; line-height: 1.7em; } toc > ol > li { font-size: +1.1em; font-weight: bold; } toc ol > li > ol { font-size: 0.9em; } +toc ol ol > li > ol { padding-left: 2.3em; } toc ol + li { +margin-top: 0.3em; } toc.hidden { padding: 10px; background: fefefe; +box-shadow: none; } toc.hidden:hover { background: fafafa; } filecontents +h1 + toc.nofloat { margin-top: 0; } @media (max-width: 560px) {

+ +
#toc {
+  margin-left: 0;
+  margin-top: 16px;
+  float: none;
+  max-width: none;
+}
+ +

}

+ +

/* syntax highlighting */ .source_code { display: none; padding: 3px 8px; +border-left: 8px solid ddd; margin-top: 5px; } filecontents pre.code, +.docstring pre.code, .source_code pre { font-family: monospace; } +filecontents pre.code, .docstring pre.code { display: block; } .source_code +.lines { padding-right: 12px; color: #555; text-align: right; } +filecontents pre.code, .docstring pre.code, .tags pre.example {

+ +
padding: 9px 14px;
+margin-top: 4px;
+border: 1px solid #e1e1e8;
+background: #f7f7f9;
+border-radius: 4px;
+font-size: 1em;
+overflow-x: auto;
+line-height: 1.2em;
+ +

} pre.code { color: #000; tab-size: 2; } pre.code .info.file { color: #555; +} pre.code .val { color: #036A07; } pre.code .tstring_content, pre.code +.heredoc_beg, pre.code .heredoc_end, pre.code .qwords_beg, pre.code +.qwords_end, pre.code .qwords_sep, pre.code .words_beg, pre.code +.words_end, pre.code .words_sep, pre.code .qsymbols_beg, pre.code +.qsymbols_end, pre.code .qsymbols_sep, pre.code .symbols_beg, pre.code +.symbols_end, pre.code .symbols_sep, pre.code .tstring, pre.code .dstring { +color: #036A07; } pre.code .fid, pre.code .rubyid_new, pre.code +.rubyid_to_s, pre.code .rubyid_to_sym, pre.code .rubyid_to_f, pre.code .dot ++ pre.code .id, pre.code .rubyid_to_i pre.code .rubyid_each { color: +#0085FF; } pre.code .comment { color: #0066FF; } pre.code .const, pre.code +.constant { color: #585CF6; } pre.code .label, pre.code .symbol { color: +#C5060B; } pre.code .kw, pre.code .rubyid_require, pre.code .rubyid_extend, +pre.code .rubyid_include { color: #0000FF; } pre.code .ivar { color: +#318495; } pre.code .gvar, pre.code .rubyid_backref, pre.code +.rubyid_nth_ref { color: #6D79DE; } pre.code .regexp, .dregexp { color: +#036A07; } pre.code a { border-bottom: 1px dotted bbf; } /* inline code */

+ +
:not(pre) > code {
+       padding: 1px 3px 1px 3px;
+       border: 1px solid #E1E1E8;
+       background: #F7F7F9;
+       border-radius: 4px;
+ +

}

+ +

/* Color fix for links */ content .summary_desc pre.code .id > +.object_link a, /* identifier */ content .docstring pre.code .id > +.object_link a { color: #0085FF; } content .summary_desc pre.code .const +> .object_link a, /* constant */ content .docstring pre.code .const > +.object_link a { color: #585CF6; }

+
+ + + + + diff --git a/doc/docs/file_README_html.html b/doc/docs/file_README_html.html new file mode 100644 index 00000000..32dfe5a3 --- /dev/null +++ b/doc/docs/file_README_html.html @@ -0,0 +1,1442 @@ + + + + + + +file.README.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="UTF-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
File: README
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "README";
+relpath = '';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="file_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="_index.html">Index</a> &raquo; 
+  <span class="title">File: README</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><div id='filecontents'><h1 id="dropboxapi">DropboxApi</h1>
+ +

<p>Library for communicating with Dropbox API v2.</p>

+ +

<h2 id=“installation”>Installation</h2>

+ +

<p>Add this line to your application&#39;s Gemfile:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_gem'>gem</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>dropbox_api</span><span +class='tstring_end'>&#39;</span></span> +</code></pre>

+ +

<p>And then execute:</p>

+ +

<pre class=“code ruby”><code class=“ruby”>$ bundle +</code></pre>

+ +

<p>Or install it yourself as:</p>

+ +

<pre class=“code ruby”><code class=“ruby”>$ gem install +dropbox_api </code></pre>

+ +

<h2 id=“documentation”>Documentation</h2>

+ +

<p>Please, refer to this gem&#39;s custom <a href=“Dropbox”>jesus.github.io/dropbox_api“>Dropbox +API documentation</a>. Most of the time you&#39;ll be checking +the <a href=”available“>jesus.github.io/dropbox_api/DropboxApi/Client.html”>available +endpoints</a>.</p>

+ +

<p>Unfortunately, the documentation at <a href=“RubyDoc.infowww.rubydoc.info”>RubyDoc.info> +is disrecommended because it lacks some nice features that have been added +with YARD plugins:</p>

+ +

<ul> <li>Each endpoint includes its tests right below the +description, this works as an example of its usage.</li> +<li>All endpoints are shown as methods of the Client +class, just as you will use them.</li> </ul>

+ +

<h2 id=“basic-set-up”>Basic set up</h2>

+ +

<h3 id=“authorize-your-application”>Authorize your +application</h3>

+ +

<p>Dropbox uses OAuth, in order to use this library from your +application you&#39;ll have to get an authorization code.</p>

+ +

<p>Once you have it, just pass it on client initialization:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>VofXAX8D…</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Client …&gt; +</span></code></pre>

+ +

<p>Or set it as an ENV variable called +DROPBOX_OAUTH_BEARER, for example:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='const'>ENV</span><span +class='lbracket'>[</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>DROPBOX_OAUTH_BEARER</span><span +class='tstring_end'>&quot;</span></span><span +class='rbracket'>]</span> <span +class='op'>=</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>VofXAX8D…</span><span +class='tstring_end'>&quot;</span></span> +<span class='const'><span +class='object_link'><a href=“DropboxApi.html” +title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Client …&gt; +</span></code></pre>

+ +

<p>The official documentation on the process to get an authorization +code is <a href=“heredevelopers.dropbox.com/es-es/oauth-guide#implementing-oauth”>here>, +it describes the two options listed below.</p>

+ +

<h4 id=“option-a-get-your-access-token-from-the-website”>Option A: +Get your access token from the website</h4>

+ +

<p>For a quick test, you can obtain an access token from the App +Console in <a href=“Dropbox's”>www.dropbox.com/developers/“>Dropbox's +website</a>. Select from My apps your application, you may +need to create one if you haven&#39;t done so yet. Under your +application settings, find section OAuth 2, there is a button to +generate an access token.</p>

+ +

<h4 id=“option-b-oauth2-code-flow”>Option B: OAuth2 Code +Flow</h4>

+ +

<p>This is typically what you will use in production, you can obtain +an authorization code with a 3-step process:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='comment'># 1. Get an authorization URL. +</span><span class='id identifier +rubyid_authenticator'>authenticator</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Authenticator.html” title=“DropboxApi::Authenticator +(class)”>Authenticator</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Authenticator.html#initialize-instance_method” +title=“DropboxApi::Authenticator#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='const'>CLIENT_ID</span><span +class='comma'>,</span> <span +class='const'>CLIENT_SECRET</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_authenticator'>authenticator</span><span +class='period'>.</span><span class='id identifier +rubyid_auth_code'>auth_code</span><span +class='period'>.</span><span class='id identifier +rubyid_authorize_url'>authorize_url</span> <span +class='comment'>#=&gt; &quot;www.dropbox.com/…"; +</span> <span class='comment'># 2. Log into Dropbox and +authorize your app. You need to open the </span><span +class='comment'># authorization URL in your browser. +</span> <span class='comment'># 3. Exchange the +authorization code for a reusable access token (not visible +</span><span class='comment'># to the user). +</span><span class='id identifier +rubyid_access_token'>access_token</span> <span +class='op'>=</span> <span class='id identifier +rubyid_authenticator'>authenticator</span><span +class='period'>.</span><span class='id identifier +rubyid_auth_code'>auth_code</span><span +class='period'>.</span><span class='id identifier +rubyid_get_token'>get_token</span><span +class='lparen'>(</span><span +class='const'>CODE</span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; #&lt;OAuth2::AccessToken +…&gt;` </span><span class='id identifier +rubyid_access_token'>access_token</span><span +class='period'>.</span><span class='id identifier +rubyid_token'>token</span> <span +class='comment'>#=&gt; &quot;VofXAX8D…&quot; +</span> <span class='comment'># Keep this token, +you&#39;ll need it to initialize a `DropboxApi::Client` object: +</span><span class='id identifier +rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='label'>access_token:</span> <span class='id +identifier rubyid_access_token'>access_token</span><span +class='rparen'>)</span>

+ +

<span class='comment'># For backwards compatibility, the +following also works: </span><span class='id identifier +rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span class='id identifier +rubyid_access_token'>access_token</span><span +class='period'>.</span><span class='id identifier +rubyid_token'>token</span><span +class='rparen'>)</span> </code></pre>

+ +

<h5 id=“integration-with-rails”>Integration with Rails</h5>

+ +

<p>If you have a Rails application, you might be interested in this +<a href=“setup”>jesus.github.io/dropbox_api/file.rails_setup.html“>setup +guide</a>.</p>

+ +

<h5 id=“using-refresh-tokens”>Using refresh tokens</h5>

+ +

<p>Access tokens are short-lived by default (as of September 30th, +2021), applications that require long-lived access to the API without +additional interaction with the user should use refresh tokens.</p>

+ +

<p>The process is similar but a token refresh might seamlessly occur +as you perform API calls. When this happens you&#39;ll need to store +the new token hash if you want to continue using this session, you can use +the on_token_refreshed callback to do this.</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='comment'># 1. Get an authorization URL, requesting +offline access type. </span><span class='id identifier +rubyid_authenticator'>authenticator</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Authenticator.html” title=“DropboxApi::Authenticator +(class)”>Authenticator</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Authenticator.html#initialize-instance_method” +title=“DropboxApi::Authenticator#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='const'>CLIENT_ID</span><span +class='comma'>,</span> <span +class='const'>CLIENT_SECRET</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_authenticator'>authenticator</span><span +class='period'>.</span><span class='id identifier +rubyid_auth_code'>auth_code</span><span +class='period'>.</span><span class='id identifier +rubyid_authorize_url'>authorize_url</span><span +class='lparen'>(</span><span +class='label'>token_access_type:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>offline</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='comment'># 2. Log into Dropbox and authorize +your app. You need to open the </span><span +class='comment'># authorization URL in your browser. +</span> <span class='comment'># 3. Exchange the +authorization code for a reusable access token </span><span +class='id identifier +rubyid_access_token'>access_token</span> <span +class='op'>=</span> <span class='id identifier +rubyid_authenticator'>authenticator</span><span +class='period'>.</span><span class='id identifier +rubyid_auth_code'>auth_code</span><span +class='period'>.</span><span class='id identifier +rubyid_get_token'>get_token</span><span +class='lparen'>(</span><span +class='const'>CODE</span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; #&lt;OAuth2::AccessToken +…&gt;` </span> <span class='comment'># You can now +use the access token to initialize a DropboxApi::Client, you +</span><span class='comment'># should also provide a +callback function to store the updated access token </span><span +class='comment'># whenever it&#39;s refreshed. +</span><span class='id identifier +rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span>

+ +
<span class='label'>access_token:</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span>
+<span class='label'>on_token_refreshed:</span> <span class='id identifier rubyid_lambda'>lambda</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_new_token_hash'>new_token_hash</span><span class='op'>|</span>
+  <span class='comment'># token_hash is a serializable Hash, something like this:
+ +

</span> <span class='comment'># { </span> +<span class='comment'># +&quot;uid&quot;=&gt;&quot;440&quot;, </span> +<span class='comment'># +&quot;token_type&quot;=&gt;&quot;bearer&quot;, +</span> <span class='comment'># +&quot;scope&quot;=&gt;&quot;account_info.read +account_info.write…&quot;, </span> <span +class='comment'># +&quot;account_id&quot;=&gt;&quot;dbid:AABOLtA1rT6rRK4vajKZ…&quot;, +</span> <span class='comment'># +:access_token=&gt;&quot;sl.A5Ez_CBsqJILhDawHlmXSoZEhLZ4nuLFVRs6AJ…&quot;, +</span> <span class='comment'># +:refresh_token=&gt;&quot;iMg4Me_oKYUAAAAAAAAAAapQixCgwfXOxuubCuK_…&quot;, +</span> <span class='comment'># +:expires_at=&gt;1632948328 </span> <span +class='comment'># } </span> <span +class='const'>SomewhereSafe</span><span +class='period'>.</span><span class='id identifier +rubyid_save'>save</span><span +class='lparen'>(</span><span class='id identifier +rubyid_new_token_hash'>new_token_hash</span><span +class='rparen'>)</span>

+ +
<span class='rbrace'>}</span>
+ +

<span class='rparen'>)</span> </code></pre>

+ +

<p>Once you&#39;ve gone through the process above, you can skip +the steps that require user interaction in subsequent initializations of +DropboxApi::Client. For example:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='comment'># 1. Initialize an authenticator +</span><span class='id identifier +rubyid_authenticator'>authenticator</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Authenticator.html” title=“DropboxApi::Authenticator +(class)”>Authenticator</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Authenticator.html#initialize-instance_method” +title=“DropboxApi::Authenticator#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='const'>CLIENT_ID</span><span +class='comma'>,</span> <span +class='const'>CLIENT_SECRET</span><span +class='rparen'>)</span>

+ +

<span class='comment'># 2. Retrieve the token hash you +previously stored somewhere safe, you can use </span><span +class='comment'># it to build a new access token. +</span><span class='id identifier +rubyid_access_token'>access_token</span> <span +class='op'>=</span> <span +class='const'>OAuth2</span><span +class='op'>::</span><span +class='const'>AccessToken</span><span +class='period'>.</span><span class='id identifier +rubyid_from_hash'>from_hash</span><span +class='lparen'>(</span><span class='id identifier +rubyid_authenticator'>authenticator</span><span +class='comma'>,</span> <span class='id identifier +rubyid_token_hash'>token_hash</span><span +class='rparen'>)</span>

+ +

<span class='comment'># 3. You now have an access token, so +you can initialize a client like you </span><span +class='comment'># would normally: </span><span +class='id identifier rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span>

+ +
<span class='label'>access_token:</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span>
+<span class='label'>on_token_refreshed:</span> <span class='id identifier rubyid_lambda'>lambda</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_new_token_hash'>new_token_hash</span><span class='op'>|</span>
+  <span class='const'>SomewhereSafe</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span><span class='lparen'>(</span><span class='id identifier rubyid_new_token_hash'>new_token_hash</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span>
+ +

<span class='rparen'>)</span> </code></pre>

+ +

<h3 id=“performing-api-calls”>Performing API calls</h3>

+ +

<p>Once you&#39;ve initialized a client, for example:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>VofXAX8D…</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Client …&gt; +</span></code></pre>

+ +

<p>You can perform an API call like this:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_result'>result</span> <span +class='op'>=</span> <span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder'>list_folder</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/sample_folder</span><span +class='tstring_end'>&quot;</span></span> +<span class='comment'>#=&gt; +#&lt;DropboxApi::Results::ListFolderResult&gt; +</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_entries'>entries</span> <span +class='comment'>#=&gt; +[#&lt;DropboxApi::Metadata::Folder&gt;, +#&lt;DropboxApi::Metadata::File&gt;] </span><span +class='id identifier rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_has_more?'>has_more?</span> <span +class='comment'>#=&gt; false +</span></code></pre>

+ +

<p>The instance of Client we&#39;ve initialized is +the one you&#39;ll be using to perform API calls. You can check the +class&#39; documentation to find <a href=“all”>jesus.github.io/dropbox_api/DropboxApi/Client.html“>all +available endpoints</a>.</p>

+ +

<h3 id=“large-file-uploads”>Large file uploads</h3>

+ +

<p>If you need to upload files larger than 150MB the default +#upload endpoint won&#39;t work. Instead, you need to +start a upload session and upload the file in small chunks.</p>

+ +

<p>To make this easier, the method upload_by_chunks will +handle this for you, example:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>VofXAX8D…</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Client …&gt; +</span><span class='const'>File</span><span +class='period'>.</span><span class='id identifier +rubyid_open'>open</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>large_file.avi</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_f'>f</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload_by_chunks'>upload_by_chunks</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/remote_path.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_f'>f</span>
+ +

<span class='kw'>end</span> </code></pre>

+ +

<p>Check out the <a href=“method”>www.xuuso.com/dropbox_api/DropboxApi/Client.html#upload_by_chunks-instance_method“>method +documentation</a> to find out all available options.</p>

+ +

<h3 id=“accessing-team-folders”>Accessing Team Folders</h3>

+ +

<p>In order to access your team scope you need to add the +namespace_id to you request headers. This can be done using the middlewere +layer as per the below:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>VofXAX8D…</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Client …&gt; +</span><span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_namespace_id'>namespace_id</span> <span +class='op'>=</span> <span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_current_account'>get_current_account</span><span +class='period'>.</span><span class='id identifier +rubyid_root_info'>root_info</span><span +class='period'>.</span><span class='id identifier +rubyid_root_namespace_id'>root_namespace_id</span>

+ +

<span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder'>list_folder</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; Now returns the team folders +</span></code></pre>

+ +

<p>You could unset the namespace ID at any point afterwards with +just:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_namespace_id'>namespace_id</span> <span +class='op'>=</span> <span +class='kw'>nil</span> </code></pre>

+ +

<h2 id=“dependencies”>Dependencies</h2>

+ +

<p>This gem depends on <a href=“oauth2github.com/oauth-xx/oauth2”>oauth2> +and <a href=“faraday.github.com/lostisland/faraday”>faraday.>

+ +

<p>It has official support for Ruby versions +2.x.</p>

+ +

<h2 id=“development”>Development</h2>

+ +

<p>After checking out the repo, run bin/setup to install +dependencies. Then, run bin/console for an interactive prompt +that will allow you to experiment.</p>

+ +

<h3 id=“testing”>Testing</h3>

+ +

<p>I recommend you to use a test account other than your main +one.</p>

+ +

<p>We use VCR to record the HTTP calls to Dropbox, however we +sometimes need to regenerate the cassettes. Let&#39;s take +list_folder as an example to show what would be the procedure +to do so:</p>

+ +

<ol> <li><p>Manually delete the existing cassettes in +spec/fixtures/vcr_cassettes/list_folder/*.yml.</p></li> +<li><p>Run the task to build the scaffolding in your Dropbox +account so the tests will pass. If it doesn&#39;t exist you may need to +write it yourself, check the DropboxScaffoldBuilder class to +find all existing scaffold builders.</p>

+ +

<pre class=“code text”><code +class=“text”>DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rake test:build_scaffold </code></pre>

+ +

<p>Note that you&#39;ll have to type rake +test:build_scaffold\[list_folder\] if you use +zsh.</p>

+ +

<p>You can build all available scaffolds with just rake +test:build_scaffold.</p></li> <li><p>Run the +tests and the cassettes will be written:</p>

+ +

<pre class=“code text”><code +class=“text”>DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rspec +spec/endpoints/files/list_folder_spec.rb +</code></pre></li> </ol>

+ +

<p>The OAuth bearer shouldn&#39;t have been recorded in the +cassette and it should&#39;ve been filtered. However, you may want to +double check before pushing your updates to Github.</p>

+ +

<p>Tip: you can simply run export +DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER at the beginning of your work +session so you don&#39;t need to prefix it in every command +line.</p>

+ +

<h2 id=“contributing”>Contributing</h2>

+ +

<p>Any help will be much appreciated. The easiest way to help is to +implement one or more of the <a href=“endpoints”>jesus.github.io/dropbox_api/file.api_coverage.html“>endpoints +that are still pending</a>. To see how the endpoints are implemented, +check out the lib/dropbox_api/endpoints folder.</p> +</div></div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/file_api_coverage_html.html b/doc/docs/file_api_coverage_html.html new file mode 100644 index 00000000..22b7fe76 --- /dev/null +++ b/doc/docs/file_api_coverage_html.html @@ -0,0 +1,1058 @@ + + + + + + +file.api_coverage.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="UTF-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
File: API Implementation Coverage
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "api_coverage";
+relpath = '';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="file_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="_index.html">Index</a> &raquo; 
+  <span class="title">File: API Implementation Coverage</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><div id='filecontents'><p>The Dropbox API changes frequently, so you may find out that the feature that
+ +

you need is missing. This document indicates what endpoints have been +implemented.</p>

+ +

<p>Full moon means fully implemented. Half moon means that the basic +functionality of the endpoint has been implemented but some options may be +missing. Guess what new moon means.</p>

+ +

<h2 id=“file-properties”>File properties</h2>

+ +

<table><thead> <tr> <th>API call</th> <th +style=“text-align: center”>Status</th> </tr> +</thead><tbody> <tr> +<td>/properties/add</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/properties/overwrite</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/properties/remove</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/properties/search</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/properties/search/continue</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/properties/update</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/templates/add_for_user</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/templates/get_for_user</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/templates/list_for_user</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/templates/remove_for_user</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/templates/update_for_user</td> <td +style=“text-align: center”>🌑</td> </tr> +</tbody></table>

+ +

<h2 id=“file-requests”>File requests</h2>

+ +

<table><thead> <tr> <th>API call</th> <th +style=“text-align: center”>Status</th> </tr> +</thead><tbody> <tr> +<td>/create</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/get</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/list</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/update</td> <td style=“text-align: +center”>🌑</td> </tr> </tbody></table>

+ +

<h2 id=“files”>Files</h2>

+ +

<table><thead> <tr> <th>API call</th> <th +style=“text-align: center”>Status</th> </tr> +</thead><tbody> <tr> +<td>/copy</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/copy_batch</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/copy_batch/check</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/copy_reference/get</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/copy_reference/save</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/create_folder</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/create_folder_batch</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/create_folder_batch/check</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/delete</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/delete_batch</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/delete_batch/check</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/download</td> <td style=“text-align: +center”>🌔</td> </tr> <tr> +<td>/download_zip</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/get_metadata</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/get_preview</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/get_temporary_link</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/get_temporary_upload_link</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/get_thumbnail</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/get_thumbnail_batch</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/list_folder</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/list_folder/continue</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/list_folder/get_latest_cursor</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/list_folder/longpoll</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/list_revisions</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/move</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/move_batch</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/move_batch/check</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/permanently_delete</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/restore</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/save_url</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/save_url/check_job_status</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/search_v2</td> <td style=“text-align: +center”>🌔</td> </tr> <tr> +<td>/upload</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/upload_session/append</td> <td +style=“text-align: center”>alias?</td> </tr> <tr> +<td>/upload_session/append_v2</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/upload_session/finish</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/upload_session/finish_batch</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/upload_session/finish_batch/check</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/upload_session/start</td> <td +style=“text-align: center”>🌕</td> </tr> +</tbody></table>

+ +

<h2 id=“paper”>Paper</h2>

+ +

<table><thead> <tr> <th>API call</th> <th +style=“text-align: center”>Status</th> </tr> +</thead><tbody> <tr> +<td>/docs/archive</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/docs/create</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/docs/download</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/docs/folder_users/list</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/docs/folder_users/list/continue</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/docs/get_folder_info</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/docs/list</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/docs/list/continue</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/docs/permanently_delete</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/docs/sharing_policy/get</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/docs/sharing_policy/set</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/docs/update</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/docs/users/add</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/docs/users/list</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/docs/users/list/continue</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/docs/users/remove</td> <td +style=“text-align: center”>🌑</td> </tr> +</tbody></table>

+ +

<h2 id=“sharing”>Sharing</h2>

+ +

<table><thead> <tr> <th>API call</th> <th +style=“text-align: center”>Status</th> </tr> +</thead><tbody> <tr> +<td>/add_file_member</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/add_folder_member</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/check_job_status</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/check_remove_member_job_status</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/check_share_job_status</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/create_shared_link_with_settings</td> <td +style=“text-align: center”>🌓</td> </tr> <tr> +<td>/get_file_metadata</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/get_file_metadata/batch</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/get_folder_metadata</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/get_shared_link_file</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/get_shared_link_metadata</td> <td +style=“text-align: center”>🌔</td> </tr> <tr> +<td>/list_file_members</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/list_file_members/batch</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/list_file_members/continue</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/list_folder_members</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/list_folder_members/continue</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/list_folders</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/list_folders/continue</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/list_mountable_folders</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/list_mountable_folders/continue</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/list_received_files</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/list_received_files/continue</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/list_shared_links</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/modify_shared_link_settings</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/mount_folder</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/relinquish_file_membership</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/relinquish_folder_membership</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/remove_file_member_2</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/remove_folder_member</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/revoke_shared_link</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/set_access_inheritance</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/share_folder</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/transfer_folder</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/unmount_folder</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/unshare_file</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/unshare_folder</td> <td style=“text-align: +center”>🌑</td> </tr> <tr> +<td>/update_file_member</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/update_folder_member</td> <td +style=“text-align: center”>🌑</td> </tr> <tr> +<td>/update_folder_policy</td> <td +style=“text-align: center”>🌑</td> </tr> +</tbody></table>

+ +

<h2 id=“users”>Users</h2>

+ +

<table><thead> <tr> <th>API call</th> <th +style=“text-align: center”>Status</th> </tr> +</thead><tbody> <tr> +<td>/get_account</td> <td style=“text-align: +center”>🌕</td> </tr> <tr> +<td>/get_account_batch</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/get_current_account</td> <td +style=“text-align: center”>🌕</td> </tr> <tr> +<td>/get_space_usage</td> <td +style=“text-align: center”>🌕</td> </tr> +</tbody></table>

+ +

<h2 id=“dropbox-business-api”>Dropbox Business API</h2>

+ +

<p>Unfortunately, none of the Dropbox Business endpoints have been +implemented. If this is a problem for you, please <a href=“open”>github.com/Jesus/dropbox_api/issues/new“>open +an issue</a>.</p> </div></div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/file_list_html.html b/doc/docs/file_list_html.html new file mode 100644 index 00000000..be9b7a12 --- /dev/null +++ b/doc/docs/file_list_html.html @@ -0,0 +1,760 @@ + + + + + + +file_list.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta charset="utf-8" />
+
+    <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
+
+    <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
+
+    <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+    <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+
+  <title>File List</title>
+  <base id="base_target" target="_parent" />
+</head>
+<body>
+  <div id="content">
+    <div class="fixed_header">
+      <h1 id="full_list_header">File List</h1>
+      <div id="full_list_nav">
+
+          <span><a target="_self" href="class_list.html">
+            Classes
+          </a></span>
+
+          <span><a target="_self" href="method_list.html">
+            Methods
+          </a></span>
+
+          <span><a target="_self" href="file_list.html">
+            Files
+          </a></span>
+
+      </div>
+
+      <div id="search">Search: <input type="text" /></div>
+    </div>
+
+    <ul id="full_list" class="file">
+
+<li id="object_README" class="odd">
+  <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
+</li>
+
+<li id="object_api_coverage" class="even">
+  <div class="item"><span class="object_link"><a href="file.api_coverage.html" title="API Implementation Coverage">API Implementation Coverage</a></span></div>
+</li>
+
+<li id="object_rails_setup" class="odd">
+  <div class="item"><span class="object_link"><a href="file.rails_setup.html" title="Rails setup">Rails setup</a></span></div>
+</li>
+
+    </ul>
+  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/file_rails_setup_html.html b/doc/docs/file_rails_setup_html.html new file mode 100644 index 00000000..41efe7fb --- /dev/null +++ b/doc/docs/file_rails_setup_html.html @@ -0,0 +1,932 @@ + + + + + + +file.rails_setup.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="UTF-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
File: Rails setup
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "rails_setup";
+relpath = '';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="file_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="_index.html">Index</a> &raquo; 
+  <span class="title">File: Rails setup</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><div id='filecontents'><h1 id="standard-oauth-2-flow-set-up">Standard OAuth 2 flow set up</h1>
+ +

<p>This document describes how to implement the OAuth2 flow in a +Rails application, the process is represented in the following +diagram:</p>

+ +

<p><img src=“” alt=“Oauth 2 flow”></p>

+ +

<p>Source: <a href=“https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-webwww.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web”>https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web>

+ +

<h2 id=“1-set-up-some-new-routes”>1. Set up some new +routes</h2>

+ +

<p>You&#39;ll have to create a couple of new routes:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_get'>get</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>dropbox/auth</span><span +class='tstring_end'>&#39;</span></span> <span +class='op'>=&gt;</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>dropbox#auth</span><span +class='tstring_end'>&#39;</span></span> <span +class='id identifier rubyid_get'>get</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>dropbox/auth_callback</span><span +class='tstring_end'>&#39;</span></span> <span +class='op'>=&gt;</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>dropbox#auth_callback</span><span +class='tstring_end'>&#39;</span></span> +</code></pre>

+ +

<p>We&#39;ll use dropbox/auth to perform the step 2 +in the diagram, i.e. this route will redirect to Dropbox.</p>

+ +

<p>The other route, dropbox/auth_callback, will process +the authentication token that we&#39;ll receive from Dropbox. Steps 4 +&amp; 5.</p>

+ +

<h2 id=“2-set-up-a-dropbox-controller”>2. Set up a Dropbox +controller</h2>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='kw'>class</span> <span +class='const'>DropboxController</span> <span +class='op'>&lt;</span> <span +class='const'>ApplicationController</span>

+ +
<span class='comment'># Example call:
+ +

</span> <span class='comment'># GET /dropbox/auth +</span> <span class='kw'>def</span> <span +class='id identifier rubyid_auth'>auth</span>

+ +
  <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='id identifier rubyid_authenticator'>authenticator</span><span class='period'>.</span><span class='id identifier rubyid_authorize_url'>authorize_url</span> <span class='symbol'>:redirect_uri</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_redirect_uri'>redirect_uri</span>
+
+  <span class='id identifier rubyid_redirect_to'>redirect_to</span> <span class='id identifier rubyid_url'>url</span>
+<span class='kw'>end</span>
+
+<span class='comment'># Example call:
+ +

</span> <span class='comment'># GET +/dropbox/auth_callback?code=VofXAX8DO1sAAAAAAAACUKBwkDZyMg1zKT0f_FNONeA +</span> <span class='kw'>def</span> <span +class='id identifier +rubyid_auth_callback'>auth_callback</span>

+ +
<span class='id identifier rubyid_auth_bearer'>auth_bearer</span> <span class='op'>=</span> <span class='id identifier rubyid_authenticator'>authenticator</span><span class='period'>.</span><span class='id identifier rubyid_get_token'>get_token</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:code</span><span class='rbracket'>]</span><span class='comma'>,</span>
+                                      <span class='symbol'>:redirect_uri</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_redirect_uri'>redirect_uri</span><span class='rparen'>)</span>
+<span class='id identifier rubyid_token'>token</span> <span class='op'>=</span> <span class='id identifier rubyid_auth_bearer'>auth_bearer</span><span class='period'>.</span><span class='id identifier rubyid_token'>token</span> <span class='comment'># This line is step 5 in the diagram.
+ +

</span>

+ +
<span class='comment'># At this stage you may want to persist the reusable token we&#39;ve acquired.
+ +

</span> <span class='comment'># Remember that +it&#39;s bound to the Dropbox account of your user. </span>

+ +
<span class='comment'># If you persist this token, you can use it in subsequent requests or
+ +

</span> <span class='comment'># background jobs to +perform calls to Dropbox API such as the following. </span> +<span class='id identifier +rubyid_folders'>folders</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span class='id identifier +rubyid_token'>token</span><span +class='rparen'>)</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder'><span class='object_link'><a +href=“DropboxApi/Client.html#list_folder-instance_method” +title=“DropboxApi::Client#list_folder +(method)”>list_folder</a></span></span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/</span><span +class='tstring_end'>&quot;</span></span>

+ +
<span class='kw'>end</span>
+
+<span class='id identifier rubyid_private'>private</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_authenticator'>authenticator</span>
+  <span class='id identifier rubyid_client_id'>client_id</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>az8ykn83kecoodq</span><span class='tstring_end'>&quot;</span></span>
+  <span class='id identifier rubyid_client_secret'>client_secret</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ozp1pxo8e563fc5</span><span class='tstring_end'>&quot;</span></span>
+
+  <span class='const'><span class='object_link'><a href="DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="DropboxApi/Authenticator.html" title="DropboxApi::Authenticator (class)">Authenticator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="DropboxApi/Authenticator.html#initialize-instance_method" title="DropboxApi::Authenticator#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_client_id'>client_id</span><span class='comma'>,</span> <span class='id identifier rubyid_client_secret'>client_secret</span><span class='rparen'>)</span>
+<span class='kw'>end</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_redirect_uri'>redirect_uri</span>
+  <span class='id identifier rubyid_dropbox_auth_callback_url'>dropbox_auth_callback_url</span> <span class='comment'># =&gt; http://localhost:3000/dropbox/auth_callback
+ +

</span> <span class='kw'>end</span> <span +class='kw'>end</span> </code></pre>

+ +

<h2 id=“3-set-up-redirect-uri-in-your-dropbox-app-settings”>3. Set up +redirect URI in your Dropbox app settings</h2>

+ +

<p>In the previous code, you probably noticed that we&#39;re +providing a redirect_uri parameter. This is where the user +will be redirected to after accepting our application.</p>

+ +

<p>However, Dropbox will only redirect to a set of whitelisted URIs, +so you&#39;ll need to add yours to the list. That&#39;s very +easy:</p>

+ +

<ol> <li>Log in to your Dropbox developer account at <a +href=“www.dropbox.com/developers.www.dropbox.com/developers”>www.dropbox.com/developers.> +<li>On the menu, click on &quot;My Apps&quot;. Then click on +your application to edit its settings.</li> <li>On the OAuth 2 +section, add the redirect URI that maps to the auth_callback +method that we&#39;ve implemented above. For example, +www.yourapp.com/dropbox/oauth_callback.> </ol> +</div></div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/frames_html.html b/doc/docs/frames_html.html new file mode 100644 index 00000000..287735ad --- /dev/null +++ b/doc/docs/frames_html.html @@ -0,0 +1,720 @@ + + + + + + +frames.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html> <head>

+ +
<meta charset="utf-8">
+      <title>Documentation by YARD 0.9.26</title>
+ +

</head> <script type=“text/javascript”>

+ +
var match = unescape(window.location.hash).match(/^#!(.+)/);
+var name = match ? match[1] : 'index.html';
+name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
+window.top.location = name;
+
+ +

</script> <noscript>

+ +
<h1>Oops!</h1>
+<h2>YARD requires JavaScript!</h2>
+ +

</noscript> </html>

+
+ + + + + diff --git a/doc/docs/index_html.html b/doc/docs/index_html.html new file mode 100644 index 00000000..8ebabc4f --- /dev/null +++ b/doc/docs/index_html.html @@ -0,0 +1,1442 @@ + + + + + + +index.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="UTF-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
File: README
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "README";
+relpath = '';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="_index.html">Index</a> &raquo; 
+  <span class="title">File: README</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><div id='filecontents'><h1 id="dropboxapi">DropboxApi</h1>
+ +

<p>Library for communicating with Dropbox API v2.</p>

+ +

<h2 id=“installation”>Installation</h2>

+ +

<p>Add this line to your application&#39;s Gemfile:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_gem'>gem</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>dropbox_api</span><span +class='tstring_end'>&#39;</span></span> +</code></pre>

+ +

<p>And then execute:</p>

+ +

<pre class=“code ruby”><code class=“ruby”>$ bundle +</code></pre>

+ +

<p>Or install it yourself as:</p>

+ +

<pre class=“code ruby”><code class=“ruby”>$ gem install +dropbox_api </code></pre>

+ +

<h2 id=“documentation”>Documentation</h2>

+ +

<p>Please, refer to this gem&#39;s custom <a href=“Dropbox”>jesus.github.io/dropbox_api“>Dropbox +API documentation</a>. Most of the time you&#39;ll be checking +the <a href=”available“>jesus.github.io/dropbox_api/DropboxApi/Client.html”>available +endpoints</a>.</p>

+ +

<p>Unfortunately, the documentation at <a href=“RubyDoc.infowww.rubydoc.info”>RubyDoc.info> +is disrecommended because it lacks some nice features that have been added +with YARD plugins:</p>

+ +

<ul> <li>Each endpoint includes its tests right below the +description, this works as an example of its usage.</li> +<li>All endpoints are shown as methods of the Client +class, just as you will use them.</li> </ul>

+ +

<h2 id=“basic-set-up”>Basic set up</h2>

+ +

<h3 id=“authorize-your-application”>Authorize your +application</h3>

+ +

<p>Dropbox uses OAuth, in order to use this library from your +application you&#39;ll have to get an authorization code.</p>

+ +

<p>Once you have it, just pass it on client initialization:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>VofXAX8D…</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Client …&gt; +</span></code></pre>

+ +

<p>Or set it as an ENV variable called +DROPBOX_OAUTH_BEARER, for example:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='const'>ENV</span><span +class='lbracket'>[</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>DROPBOX_OAUTH_BEARER</span><span +class='tstring_end'>&quot;</span></span><span +class='rbracket'>]</span> <span +class='op'>=</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>VofXAX8D…</span><span +class='tstring_end'>&quot;</span></span> +<span class='const'><span +class='object_link'><a href=“DropboxApi.html” +title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Client …&gt; +</span></code></pre>

+ +

<p>The official documentation on the process to get an authorization +code is <a href=“heredevelopers.dropbox.com/es-es/oauth-guide#implementing-oauth”>here>, +it describes the two options listed below.</p>

+ +

<h4 id=“option-a-get-your-access-token-from-the-website”>Option A: +Get your access token from the website</h4>

+ +

<p>For a quick test, you can obtain an access token from the App +Console in <a href=“Dropbox's”>www.dropbox.com/developers/“>Dropbox's +website</a>. Select from My apps your application, you may +need to create one if you haven&#39;t done so yet. Under your +application settings, find section OAuth 2, there is a button to +generate an access token.</p>

+ +

<h4 id=“option-b-oauth2-code-flow”>Option B: OAuth2 Code +Flow</h4>

+ +

<p>This is typically what you will use in production, you can obtain +an authorization code with a 3-step process:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='comment'># 1. Get an authorization URL. +</span><span class='id identifier +rubyid_authenticator'>authenticator</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Authenticator.html” title=“DropboxApi::Authenticator +(class)”>Authenticator</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Authenticator.html#initialize-instance_method” +title=“DropboxApi::Authenticator#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='const'>CLIENT_ID</span><span +class='comma'>,</span> <span +class='const'>CLIENT_SECRET</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_authenticator'>authenticator</span><span +class='period'>.</span><span class='id identifier +rubyid_auth_code'>auth_code</span><span +class='period'>.</span><span class='id identifier +rubyid_authorize_url'>authorize_url</span> <span +class='comment'>#=&gt; &quot;www.dropbox.com/…"; +</span> <span class='comment'># 2. Log into Dropbox and +authorize your app. You need to open the </span><span +class='comment'># authorization URL in your browser. +</span> <span class='comment'># 3. Exchange the +authorization code for a reusable access token (not visible +</span><span class='comment'># to the user). +</span><span class='id identifier +rubyid_access_token'>access_token</span> <span +class='op'>=</span> <span class='id identifier +rubyid_authenticator'>authenticator</span><span +class='period'>.</span><span class='id identifier +rubyid_auth_code'>auth_code</span><span +class='period'>.</span><span class='id identifier +rubyid_get_token'>get_token</span><span +class='lparen'>(</span><span +class='const'>CODE</span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; #&lt;OAuth2::AccessToken +…&gt;` </span><span class='id identifier +rubyid_access_token'>access_token</span><span +class='period'>.</span><span class='id identifier +rubyid_token'>token</span> <span +class='comment'>#=&gt; &quot;VofXAX8D…&quot; +</span> <span class='comment'># Keep this token, +you&#39;ll need it to initialize a `DropboxApi::Client` object: +</span><span class='id identifier +rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='label'>access_token:</span> <span class='id +identifier rubyid_access_token'>access_token</span><span +class='rparen'>)</span>

+ +

<span class='comment'># For backwards compatibility, the +following also works: </span><span class='id identifier +rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span class='id identifier +rubyid_access_token'>access_token</span><span +class='period'>.</span><span class='id identifier +rubyid_token'>token</span><span +class='rparen'>)</span> </code></pre>

+ +

<h5 id=“integration-with-rails”>Integration with Rails</h5>

+ +

<p>If you have a Rails application, you might be interested in this +<a href=“setup”>jesus.github.io/dropbox_api/file.rails_setup.html“>setup +guide</a>.</p>

+ +

<h5 id=“using-refresh-tokens”>Using refresh tokens</h5>

+ +

<p>Access tokens are short-lived by default (as of September 30th, +2021), applications that require long-lived access to the API without +additional interaction with the user should use refresh tokens.</p>

+ +

<p>The process is similar but a token refresh might seamlessly occur +as you perform API calls. When this happens you&#39;ll need to store +the new token hash if you want to continue using this session, you can use +the on_token_refreshed callback to do this.</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='comment'># 1. Get an authorization URL, requesting +offline access type. </span><span class='id identifier +rubyid_authenticator'>authenticator</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Authenticator.html” title=“DropboxApi::Authenticator +(class)”>Authenticator</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Authenticator.html#initialize-instance_method” +title=“DropboxApi::Authenticator#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='const'>CLIENT_ID</span><span +class='comma'>,</span> <span +class='const'>CLIENT_SECRET</span><span +class='rparen'>)</span> <span class='id identifier +rubyid_authenticator'>authenticator</span><span +class='period'>.</span><span class='id identifier +rubyid_auth_code'>auth_code</span><span +class='period'>.</span><span class='id identifier +rubyid_authorize_url'>authorize_url</span><span +class='lparen'>(</span><span +class='label'>token_access_type:</span> <span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_content'>offline</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span>

+ +

<span class='comment'># 2. Log into Dropbox and authorize +your app. You need to open the </span><span +class='comment'># authorization URL in your browser. +</span> <span class='comment'># 3. Exchange the +authorization code for a reusable access token </span><span +class='id identifier +rubyid_access_token'>access_token</span> <span +class='op'>=</span> <span class='id identifier +rubyid_authenticator'>authenticator</span><span +class='period'>.</span><span class='id identifier +rubyid_auth_code'>auth_code</span><span +class='period'>.</span><span class='id identifier +rubyid_get_token'>get_token</span><span +class='lparen'>(</span><span +class='const'>CODE</span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; #&lt;OAuth2::AccessToken +…&gt;` </span> <span class='comment'># You can now +use the access token to initialize a DropboxApi::Client, you +</span><span class='comment'># should also provide a +callback function to store the updated access token </span><span +class='comment'># whenever it&#39;s refreshed. +</span><span class='id identifier +rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span>

+ +
<span class='label'>access_token:</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span>
+<span class='label'>on_token_refreshed:</span> <span class='id identifier rubyid_lambda'>lambda</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_new_token_hash'>new_token_hash</span><span class='op'>|</span>
+  <span class='comment'># token_hash is a serializable Hash, something like this:
+ +

</span> <span class='comment'># { </span> +<span class='comment'># +&quot;uid&quot;=&gt;&quot;440&quot;, </span> +<span class='comment'># +&quot;token_type&quot;=&gt;&quot;bearer&quot;, +</span> <span class='comment'># +&quot;scope&quot;=&gt;&quot;account_info.read +account_info.write…&quot;, </span> <span +class='comment'># +&quot;account_id&quot;=&gt;&quot;dbid:AABOLtA1rT6rRK4vajKZ…&quot;, +</span> <span class='comment'># +:access_token=&gt;&quot;sl.A5Ez_CBsqJILhDawHlmXSoZEhLZ4nuLFVRs6AJ…&quot;, +</span> <span class='comment'># +:refresh_token=&gt;&quot;iMg4Me_oKYUAAAAAAAAAAapQixCgwfXOxuubCuK_…&quot;, +</span> <span class='comment'># +:expires_at=&gt;1632948328 </span> <span +class='comment'># } </span> <span +class='const'>SomewhereSafe</span><span +class='period'>.</span><span class='id identifier +rubyid_save'>save</span><span +class='lparen'>(</span><span class='id identifier +rubyid_new_token_hash'>new_token_hash</span><span +class='rparen'>)</span>

+ +
<span class='rbrace'>}</span>
+ +

<span class='rparen'>)</span> </code></pre>

+ +

<p>Once you&#39;ve gone through the process above, you can skip +the steps that require user interaction in subsequent initializations of +DropboxApi::Client. For example:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='comment'># 1. Initialize an authenticator +</span><span class='id identifier +rubyid_authenticator'>authenticator</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Authenticator.html” title=“DropboxApi::Authenticator +(class)”>Authenticator</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Authenticator.html#initialize-instance_method” +title=“DropboxApi::Authenticator#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='const'>CLIENT_ID</span><span +class='comma'>,</span> <span +class='const'>CLIENT_SECRET</span><span +class='rparen'>)</span>

+ +

<span class='comment'># 2. Retrieve the token hash you +previously stored somewhere safe, you can use </span><span +class='comment'># it to build a new access token. +</span><span class='id identifier +rubyid_access_token'>access_token</span> <span +class='op'>=</span> <span +class='const'>OAuth2</span><span +class='op'>::</span><span +class='const'>AccessToken</span><span +class='period'>.</span><span class='id identifier +rubyid_from_hash'>from_hash</span><span +class='lparen'>(</span><span class='id identifier +rubyid_authenticator'>authenticator</span><span +class='comma'>,</span> <span class='id identifier +rubyid_token_hash'>token_hash</span><span +class='rparen'>)</span>

+ +

<span class='comment'># 3. You now have an access token, so +you can initialize a client like you </span><span +class='comment'># would normally: </span><span +class='id identifier rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span>

+ +
<span class='label'>access_token:</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='comma'>,</span>
+<span class='label'>on_token_refreshed:</span> <span class='id identifier rubyid_lambda'>lambda</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_new_token_hash'>new_token_hash</span><span class='op'>|</span>
+  <span class='const'>SomewhereSafe</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span><span class='lparen'>(</span><span class='id identifier rubyid_new_token_hash'>new_token_hash</span><span class='rparen'>)</span>
+<span class='rbrace'>}</span>
+ +

<span class='rparen'>)</span> </code></pre>

+ +

<h3 id=“performing-api-calls”>Performing API calls</h3>

+ +

<p>Once you&#39;ve initialized a client, for example:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>VofXAX8D…</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Client …&gt; +</span></code></pre>

+ +

<p>You can perform an API call like this:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_result'>result</span> <span +class='op'>=</span> <span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder'>list_folder</span> <span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>/sample_folder</span><span +class='tstring_end'>&quot;</span></span> +<span class='comment'>#=&gt; +#&lt;DropboxApi::Results::ListFolderResult&gt; +</span><span class='id identifier +rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_entries'>entries</span> <span +class='comment'>#=&gt; +[#&lt;DropboxApi::Metadata::Folder&gt;, +#&lt;DropboxApi::Metadata::File&gt;] </span><span +class='id identifier rubyid_result'>result</span><span +class='period'>.</span><span class='id identifier +rubyid_has_more?'>has_more?</span> <span +class='comment'>#=&gt; false +</span></code></pre>

+ +

<p>The instance of Client we&#39;ve initialized is +the one you&#39;ll be using to perform API calls. You can check the +class&#39; documentation to find <a href=“all”>jesus.github.io/dropbox_api/DropboxApi/Client.html“>all +available endpoints</a>.</p>

+ +

<h3 id=“large-file-uploads”>Large file uploads</h3>

+ +

<p>If you need to upload files larger than 150MB the default +#upload endpoint won&#39;t work. Instead, you need to +start a upload session and upload the file in small chunks.</p>

+ +

<p>To make this easier, the method upload_by_chunks will +handle this for you, example:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>VofXAX8D…</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Client …&gt; +</span><span class='const'>File</span><span +class='period'>.</span><span class='id identifier +rubyid_open'>open</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>large_file.avi</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span +class='kw'>do</span> <span +class='op'>|</span><span class='id identifier +rubyid_f'>f</span><span +class='op'>|</span>

+ +
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_upload_by_chunks'>upload_by_chunks</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/remote_path.txt</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_f'>f</span>
+ +

<span class='kw'>end</span> </code></pre>

+ +

<p>Check out the <a href=“method”>www.xuuso.com/dropbox_api/DropboxApi/Client.html#upload_by_chunks-instance_method“>method +documentation</a> to find out all available options.</p>

+ +

<h3 id=“accessing-team-folders”>Accessing Team Folders</h3>

+ +

<p>In order to access your team scope you need to add the +namespace_id to you request headers. This can be done using the middlewere +layer as per the below:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_client'>client</span> <span +class='op'>=</span> <span +class='const'><span class='object_link'><a +href=“DropboxApi.html” title=“DropboxApi +(module)”>DropboxApi</a></span></span><span +class='op'>::</span><span +class='const'><span class='object_link'><a +href=“DropboxApi/Client.html” title=“DropboxApi::Client +(class)”>Client</a></span></span><span +class='period'>.</span><span class='id identifier +rubyid_new'><span class='object_link'><a +href=“DropboxApi/Client.html#initialize-instance_method” +title=“DropboxApi::Client#initialize +(method)”>new</a></span></span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&quot;</span><span +class='tstring_content'>VofXAX8D…</span><span +class='tstring_end'>&quot;</span></span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; #&lt;DropboxApi::Client …&gt; +</span><span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_namespace_id'>namespace_id</span> <span +class='op'>=</span> <span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_get_current_account'>get_current_account</span><span +class='period'>.</span><span class='id identifier +rubyid_root_info'>root_info</span><span +class='period'>.</span><span class='id identifier +rubyid_root_namespace_id'>root_namespace_id</span>

+ +

<span class='id identifier +rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_list_folder'>list_folder</span><span +class='lparen'>(</span><span +class='tstring'><span +class='tstring_beg'>&#39;</span><span +class='tstring_end'>&#39;</span></span><span +class='rparen'>)</span> <span +class='comment'>#=&gt; Now returns the team folders +</span></code></pre>

+ +

<p>You could unset the namespace ID at any point afterwards with +just:</p>

+ +

<pre class=“code ruby”><code class=“ruby”><span +class='id identifier rubyid_client'>client</span><span +class='period'>.</span><span class='id identifier +rubyid_namespace_id'>namespace_id</span> <span +class='op'>=</span> <span +class='kw'>nil</span> </code></pre>

+ +

<h2 id=“dependencies”>Dependencies</h2>

+ +

<p>This gem depends on <a href=“oauth2github.com/oauth-xx/oauth2”>oauth2> +and <a href=“faraday.github.com/lostisland/faraday”>faraday.>

+ +

<p>It has official support for Ruby versions +2.x.</p>

+ +

<h2 id=“development”>Development</h2>

+ +

<p>After checking out the repo, run bin/setup to install +dependencies. Then, run bin/console for an interactive prompt +that will allow you to experiment.</p>

+ +

<h3 id=“testing”>Testing</h3>

+ +

<p>I recommend you to use a test account other than your main +one.</p>

+ +

<p>We use VCR to record the HTTP calls to Dropbox, however we +sometimes need to regenerate the cassettes. Let&#39;s take +list_folder as an example to show what would be the procedure +to do so:</p>

+ +

<ol> <li><p>Manually delete the existing cassettes in +spec/fixtures/vcr_cassettes/list_folder/*.yml.</p></li> +<li><p>Run the task to build the scaffolding in your Dropbox +account so the tests will pass. If it doesn&#39;t exist you may need to +write it yourself, check the DropboxScaffoldBuilder class to +find all existing scaffold builders.</p>

+ +

<pre class=“code text”><code +class=“text”>DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rake test:build_scaffold </code></pre>

+ +

<p>Note that you&#39;ll have to type rake +test:build_scaffold\[list_folder\] if you use +zsh.</p>

+ +

<p>You can build all available scaffolds with just rake +test:build_scaffold.</p></li> <li><p>Run the +tests and the cassettes will be written:</p>

+ +

<pre class=“code text”><code +class=“text”>DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rspec +spec/endpoints/files/list_folder_spec.rb +</code></pre></li> </ol>

+ +

<p>The OAuth bearer shouldn&#39;t have been recorded in the +cassette and it should&#39;ve been filtered. However, you may want to +double check before pushing your updates to Github.</p>

+ +

<p>Tip: you can simply run export +DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER at the beginning of your work +session so you don&#39;t need to prefix it in every command +line.</p>

+ +

<h2 id=“contributing”>Contributing</h2>

+ +

<p>Any help will be much appreciated. The easiest way to help is to +implement one or more of the <a href=“endpoints”>jesus.github.io/dropbox_api/file.api_coverage.html“>endpoints +that are still pending</a>. To see how the endpoints are implemented, +check out the lib/dropbox_api/endpoints folder.</p> +</div></div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/js/app_js.html b/doc/docs/js/app_js.html new file mode 100644 index 00000000..be0ff265 --- /dev/null +++ b/doc/docs/js/app_js.html @@ -0,0 +1,1050 @@ + + + + + + +app.js - RDoc Documentation + + + + + + + + + + + + + + +
+ +

(function() {

+ +

var localStorage = {}, sessionStorage = {}; try { localStorage = +window.localStorage; } catch (e) { } try { sessionStorage = +window.sessionStorage; } catch (e) { }

+ +

function createSourceLinks() {

+ +
$('.method_details_list .source_code').
+    before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
+$('.toggleSource').toggle(function() {
+   $(this).parent().nextAll('.source_code').slideDown(100);
+   $(this).text("Hide source");
+},
+function() {
+    $(this).parent().nextAll('.source_code').slideUp(100);
+    $(this).text("View source");
+});
+ +

}

+ +

function createDefineLinks() {

+ +
var tHeight = 0;
+$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
+$('.toggleDefines').toggle(function() {
+    tHeight = $(this).parent().prev().height();
+    $(this).prev().css('display', 'inline');
+    $(this).parent().prev().height($(this).parent().height());
+    $(this).text("(less)");
+},
+function() {
+    $(this).prev().hide();
+    $(this).parent().prev().height(tHeight);
+    $(this).text("more...");
+});
+ +

}

+ +

function createFullTreeLinks() {

+ +
var tHeight = 0;
+$('.inheritanceTree').toggle(function() {
+    tHeight = $(this).parent().prev().height();
+    $(this).parent().toggleClass('showAll');
+    $(this).text("(hide)");
+    $(this).parent().prev().height($(this).parent().height());
+},
+function() {
+    $(this).parent().toggleClass('showAll');
+    $(this).parent().prev().height(tHeight);
+    $(this).text("show all");
+});
+ +

}

+ +

function searchFrameButtons() {

+ +
$('.full_list_link').click(function() {
+  toggleSearchFrame(this, $(this).attr('href'));
+  return false;
+});
+window.addEventListener('message', function(e) {
+  if (e.data === 'navEscape') {
+    $('#nav').slideUp(100);
+    $('#search a').removeClass('active inactive');
+    $(window).focus();
+  }
+});
+
+$(window).resize(function() {
+  if ($('#search:visible').length === 0) {
+    $('#nav').removeAttr('style');
+    $('#search a').removeClass('active inactive');
+    $(window).focus();
+  }
+});
+ +

}

+ +

function toggleSearchFrame(id, link) {

+ +
var frame = $('#nav');
+$('#search a').removeClass('active').addClass('inactive');
+if (frame.attr('src') === link && frame.css('display') !== "none") {
+  frame.slideUp(100);
+  $('#search a').removeClass('active inactive');
+}
+else {
+  $(id).addClass('active').removeClass('inactive');
+  if (frame.attr('src') !== link) frame.attr('src', link);
+  frame.slideDown(100);
+}
+ +

}

+ +

function linkSummaries() {

+ +
$('.summary_signature').click(function() {
+  document.location = $(this).find('a').attr('href');
+});
+ +

}

+ +

function summaryToggle() {

+ +
$('.summary_toggle').click(function(e) {
+  e.preventDefault();
+  localStorage.summaryCollapsed = $(this).text();
+  $('.summary_toggle').each(function() {
+    $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
+    var next = $(this).parent().parent().nextAll('ul.summary').first();
+    if (next.hasClass('compact')) {
+      next.toggle();
+      next.nextAll('ul.summary').first().toggle();
+    }
+    else if (next.hasClass('summary')) {
+      var list = $('<ul class="summary compact" />');
+      list.html(next.html());
+      list.find('.summary_desc, .note').remove();
+      list.find('a').each(function() {
+        $(this).html($(this).find('strong').html());
+        $(this).parent().html($(this)[0].outerHTML);
+      });
+      next.before(list);
+      next.toggle();
+    }
+  });
+  return false;
+});
+if (localStorage.summaryCollapsed == "collapse") {
+  $('.summary_toggle').first().click();
+} else { localStorage.summaryCollapsed = "expand"; }
+ +

}

+ +

function constantSummaryToggle() {

+ +
$('.constants_summary_toggle').click(function(e) {
+  e.preventDefault();
+  localStorage.summaryCollapsed = $(this).text();
+  $('.constants_summary_toggle').each(function() {
+    $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
+    var next = $(this).parent().parent().nextAll('dl.constants').first();
+    if (next.hasClass('compact')) {
+      next.toggle();
+      next.nextAll('dl.constants').first().toggle();
+    }
+    else if (next.hasClass('constants')) {
+      var list = $('<dl class="constants compact" />');
+      list.html(next.html());
+      list.find('dt').each(function() {
+         $(this).addClass('summary_signature');
+         $(this).text( $(this).text().split('=')[0]);
+        if ($(this).has(".deprecated").length) {
+           $(this).addClass('deprecated');
+        };
+      });
+      // Add the value of the constant as "Tooltip" to the summary object
+      list.find('pre.code').each(function() {
+        console.log($(this).parent());
+        var dt_element = $(this).parent().prev();
+        var tooltip = $(this).text();
+        if (dt_element.hasClass("deprecated")) {
+           tooltip = 'Deprecated. ' + tooltip;
+        };
+        dt_element.attr('title', tooltip);
+      });
+      list.find('.docstring, .tags, dd').remove();
+      next.before(list);
+      next.toggle();
+    }
+  });
+  return false;
+});
+if (localStorage.summaryCollapsed == "collapse") {
+  $('.constants_summary_toggle').first().click();
+} else { localStorage.summaryCollapsed = "expand"; }
+ +

}

+ +

function generateTOC() {

+ +
if ($('#filecontents').length === 0) return;
+var _toc = $('<ol class="top"></ol>');
+var show = false;
+var toc = _toc;
+var counter = 0;
+var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
+var i;
+var curli;
+if ($('#filecontents h1').length > 1) tags.unshift('h1');
+for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
+var lastTag = parseInt(tags[0][1], 10);
+$(tags.join(', ')).each(function() {
+  if ($(this).parents('.method_details .docstring').length != 0) return;
+  if (this.id == "filecontents") return;
+  show = true;
+  var thisTag = parseInt(this.tagName[1], 10);
+  if (this.id.length === 0) {
+    var proposedId = $(this).attr('toc-id');
+    if (typeof(proposedId) != "undefined") this.id = proposedId;
+    else {
+      var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
+      if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
+      this.id = proposedId;
+    }
+  }
+  if (thisTag > lastTag) {
+    for (i = 0; i < thisTag - lastTag; i++) {
+      if ( typeof(curli) == "undefined" ) {
+        curli = $('<li/>');
+        toc.append(curli);
+      }
+      toc = $('<ol/>');
+      curli.append(toc);
+      curli = undefined;
+    }
+  }
+  if (thisTag < lastTag) {
+    for (i = 0; i < lastTag - thisTag; i++) {
+      toc = toc.parent();
+      toc = toc.parent();
+    }
+  }
+  var title = $(this).attr('toc-title');
+  if (typeof(title) == "undefined") title = $(this).text();
+  curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>'); 
+  toc.append(curli);
+  lastTag = thisTag;
+});
+if (!show) return;
+html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
+$('#content').prepend(html);
+$('#toc').append(_toc);
+$('#toc .hide_toc').toggle(function() {
+  $('#toc .top').slideUp('fast');
+  $('#toc').toggleClass('hidden');
+  $('#toc .title small').toggle();
+}, function() {
+  $('#toc .top').slideDown('fast');
+  $('#toc').toggleClass('hidden');
+  $('#toc .title small').toggle();
+});
+ +

}

+ +

function navResizeFn(e) {

+ +
if (e.which !== 1) {
+  navResizeFnStop();
+  return;
+}
+
+sessionStorage.navWidth = e.pageX.toString();
+$('.nav_wrap').css('width', e.pageX);
+$('.nav_wrap').css('-ms-flex', 'inherit');
+ +

}

+ +

function navResizeFnStop() {

+ +
$(window).unbind('mousemove', navResizeFn);
+window.removeEventListener('message', navMessageFn, false);
+ +

}

+ +

function navMessageFn(e) {

+ +
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
+if (e.data.action === 'mouseup') navResizeFnStop();
+ +

}

+ +

function navResizer() {

+ +
$('#resizer').mousedown(function(e) {
+  e.preventDefault();
+  $(window).mousemove(navResizeFn);
+  window.addEventListener('message', navMessageFn, false);
+});
+$(window).mouseup(navResizeFnStop);
+
+if (sessionStorage.navWidth) {
+  navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
+}
+ +

}

+ +

function navExpander() {

+ +
var done = false, timer = setTimeout(postMessage, 500);
+function postMessage() {
+  if (done) return;
+  clearTimeout(timer);
+  var opts = { action: 'expand', path: pathId };
+  document.getElementById('nav').contentWindow.postMessage(opts, '*');
+  done = true;
+}
+
+window.addEventListener('message', function(event) {
+  if (event.data === 'navReady') postMessage();
+  return false;
+}, false);
+ +

}

+ +

function mainFocus() {

+ +
var hash = window.location.hash;
+if (hash !== '' && $(hash)[0]) {
+  $(hash)[0].scrollIntoView();
+}
+
+setTimeout(function() { $('#main').focus(); }, 10);
+ +

}

+ +

function navigationChange() {

+ +
// This works around the broken anchor navigation with the YARD template.
+window.onpopstate = function() {
+  var hash = window.location.hash;
+  if (hash !== '' && $(hash)[0]) {
+    $(hash)[0].scrollIntoView();
+  }
+};
+ +

}

+ +

$(document).ready(function() {

+ +
navResizer();
+navExpander();
+createSourceLinks();
+createDefineLinks();
+createFullTreeLinks();
+searchFrameButtons();
+linkSummaries();
+summaryToggle();
+constantSummaryToggle();
+generateTOC();
+mainFocus();
+navigationChange();
+
+ +

});

+ +

})();

+
+ + + + + diff --git a/doc/docs/js/full_list_js.html b/doc/docs/js/full_list_js.html new file mode 100644 index 00000000..8887988c --- /dev/null +++ b/doc/docs/js/full_list_js.html @@ -0,0 +1,950 @@ + + + + + + +full_list.js - RDoc Documentation + + + + + + + + + + + + + + +
+ +

(function() {

+ +

var $clicked = $(null); var searchTimeout = null; var searchCache = []; var +caseSensitiveMatch = false; var ignoreKeyCodeMin = 8; var ignoreKeyCodeMax += 46; var commandKey = 91;

+ +

RegExp.escape = function(text) {

+ +
return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
+ +

}

+ +

function escapeShortcut() {

+ +
$(document).keydown(function(evt) {
+  if (evt.which == 27) {
+    window.parent.postMessage('navEscape', '*');
+  }
+});
+ +

}

+ +

function navResizer() {

+ +
$(window).mousemove(function(e) {
+  window.parent.postMessage({
+    action: 'mousemove', event: {pageX: e.pageX, which: e.which}
+  }, '*');
+}).mouseup(function(e) {
+  window.parent.postMessage({action: 'mouseup'}, '*');
+});
+window.parent.postMessage("navReady", "*");
+ +

}

+ +

function clearSearchTimeout() {

+ +
clearTimeout(searchTimeout);
+searchTimeout = null;
+
+ +

}

+ +

function enableLinks() {

+ +
// load the target page in the parent window
+$('#full_list li').on('click', function(evt) {
+  $('#full_list li').removeClass('clicked');
+  $clicked = $(this);
+  $clicked.addClass('clicked');
+  evt.stopPropagation();
+
+  if (evt.target.tagName === 'A') return true;
+
+  var elem = $clicked.find('> .item .object_link a')[0];
+  var e = evt.originalEvent;
+  var newEvent = new MouseEvent(evt.originalEvent.type);
+  newEvent.initMouseEvent(e.type, e.canBubble, e.cancelable, e.view, e.detail, e.screenX, e.screenY, e.clientX, e.clientY, e.ctrlKey, e.altKey, e.shiftKey, e.metaKey, e.button, e.relatedTarget);
+  elem.dispatchEvent(newEvent);
+  evt.preventDefault();
+  return false;
+});
+ +

}

+ +

function enableToggles() {

+ +
// show/hide nested classes on toggle click
+$('#full_list a.toggle').on('click', function(evt) {
+  evt.stopPropagation();
+  evt.preventDefault();
+  $(this).parent().parent().toggleClass('collapsed');
+  highlight();
+});
+ +

}

+ +

function populateSearchCache() {

+ +
$('#full_list li .item').each(function() {
+  var $node = $(this);
+  var $link = $node.find('.object_link a');
+  if ($link.length > 0) {
+    searchCache.push({
+      node: $node,
+      link: $link,
+      name: $link.text(),
+      fullName: $link.attr('title').split(' ')[0]
+    });
+  }
+});
+ +

}

+ +

function enableSearch() {

+ +
$('#search input').keyup(function(event) {
+  if (ignoredKeyPress(event)) return;
+  if (this.value === "") {
+    clearSearch();
+  } else {
+    performSearch(this.value);
+  }
+});
+
+$('#full_list').after("<div id='noresults' style='display:none'></div>");
+ +

}

+ +

function ignoredKeyPress(event) {

+ +
if (
+  (event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) ||
+  (event.keyCode == commandKey)
+) {
+  return true;
+} else {
+  return false;
+}
+ +

}

+ +

function clearSearch() {

+ +
clearSearchTimeout();
+$('#full_list .found').removeClass('found').each(function() {
+  var $link = $(this).find('.object_link a');
+  $link.text($link.text());
+});
+$('#full_list, #content').removeClass('insearch');
+$clicked.parents().removeClass('collapsed');
+highlight();
+ +

}

+ +

function performSearch(searchString) {

+ +
clearSearchTimeout();
+$('#full_list, #content').addClass('insearch');
+$('#noresults').text('').hide();
+partialSearch(searchString, 0);
+ +

}

+ +

function partialSearch(searchString, offset) {

+ +
var lastRowClass = '';
+var i = null;
+for (i = offset; i < Math.min(offset + 50, searchCache.length); i++) {
+  var item = searchCache[i];
+  var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
+  var matchString = buildMatchString(searchString);
+  var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
+  if (searchName.match(matchRegexp) == null) {
+    item.node.removeClass('found');
+    item.link.text(item.link.text());
+  }
+  else {
+    item.node.addClass('found');
+    item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
+    lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
+    item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
+  }
+}
+if(i == searchCache.length) {
+  searchDone();
+} else {
+  searchTimeout = setTimeout(function() {
+    partialSearch(searchString, i);
+  }, 0);
+}
+ +

}

+ +

function searchDone() {

+ +
searchTimeout = null;
+highlight();
+if ($('#full_list li:visible').size() === 0) {
+  $('#noresults').text('No results were found.').hide().fadeIn();
+} else {
+  $('#noresults').text('').hide();
+}
+$('#content').removeClass('insearch');
+ +

}

+ +

function buildMatchString(searchString, event) {

+ +
caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
+var regexSearchString = RegExp.escape(searchString);
+if (caseSensitiveMatch) {
+  regexSearchString += "|" +
+    $.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
+    join('.+?');
+}
+return regexSearchString;
+ +

}

+ +

function highlight() {

+ +
$('#full_list li:visible').each(function(n) {
+  $(this).removeClass('even odd').addClass(n % 2 == 0 ? 'odd' : 'even');
+});
+ +

}

+ +
Expands the tree to the target element and its immediate
+children.
+ +

function expandTo(path) {

+ +
var $target = $(document.getElementById('object_' + path));
+$target.addClass('clicked');
+$target.removeClass('collapsed');
+$target.parentsUntil('#full_list', 'li').removeClass('collapsed');
+if($target[0]) {
+  window.scrollTo(window.scrollX, $target.offset().top - 250);
+  highlight();
+}
+ +

}

+ +

function windowEvents(event) {

+ +
var msg = event.data;
+if (msg.action === "expand") {
+  expandTo(msg.path);
+}
+return false;
+ +

}

+ +

window.addEventListener(“message”, windowEvents, false);

+ +

$(document).ready(function() {

+ +
escapeShortcut();
+navResizer();
+enableLinks();
+enableToggles();
+populateSearchCache();
+enableSearch();
+
+ +

});

+ +

})();

+
+ + + + + diff --git a/doc/docs/js/jquery_js.html b/doc/docs/js/jquery_js.html new file mode 100644 index 00000000..8a15bef8 --- /dev/null +++ b/doc/docs/js/jquery_js.html @@ -0,0 +1,2050 @@ + + + + + + +jquery.js - RDoc Documentation + + + + + + + + + + + + + + +
+ +
! jQuery v1.7.1 jquery.com | jquery.org/license
+ +

(function(a,b){function cy(a){return +f.isWindow(a)?a:a.nodeType===9?a.defaultView||a.parentWindow:!1}function +cv(a){if(!ck){var +b=c.body,d=f(“<”a“>”).appendTo(b),e=d.css(“display”);d.remove();if(e===“none”||e===“”){cl||(cl=c.createElement(“iframe”),cl.frameBorder=cl.width=cl.height=0),b.appendChild(cl);if(!cm||!cl.createElement)cm=(cl.contentWindow||cl.contentDocument).document,cm.write((c.compatMode===“CSS1Compat”?“<!doctype +html>”:“”)+“<html><body>”),cm.close();d=cm.createElement(a),cm.body.appendChild(d),e=f.css(d,“display”),b.removeChild(cl)}ck=e}return ck}function cu(a,b){var c={};f.each(cq.concat.apply([],cq.slice(0,b)),function(){c=a});return +c}function ct(){cr=b}function cs(){setTimeout(ct,0);return +cr=f.now()}function cj(){try{return new +a.ActiveXObject(“Microsoft.XMLHTTP”)}catch(b){}}function ci(){try{return +new a.XMLHttpRequest}catch(b){}}function +cc(a,c){a.dataFilter&&(c=a.dataFilter(c,a.dataType));var +d=a.dataTypes,e={},g,h,i=d.length,j,k=d,l,m,n,o,p;for(g=1;g<i;g++){if(g===1)for(h +in a.converters)typeof h==“string”&&(e=a.converters);l=k,k=d;if(k===“*”)k=l;else +if(l!==“*”&&l!==k){m=l+“ ”+k,n=e||e[“* +”+k];if(!n){p=b;for(o in e){j=o.split(“ ”);if(j===l||j===“*”){p=e[j+“ ”+k];if(p){o=e,o===!0?n=p:p===!0&&(n=o);break}}}}!n&&!p&&f.error(“No +conversion from ”+m.replace(“ ”,“ to +”)),n!==!0&&(c=n?n©:p(o©))}}return c}function cb(a,c,d){var +e=a.contents,f=a.dataTypes,g=a.responseFields,h,i,j,k;for(i in g)i in d&&(c[g]=d);while(f===“*”)f.shift(),h===b&&(h=a.mimeType||c.getResponseHeader(“content-type”));if(h)for(i +in e)if(e&&e.test(h)){f.unshift(i);break}if(fin d)j=f;else{for(i in d){if(!f||a.converters[i+“ +”+f]){j=i;break}k||(k=i)}j=j||k}if(j){j!==f&&f.unshift(j);return d}}function +ca(a,b,c,d){if(f.isArray(b))f.each(b,function(b,e){c||bE.test(a)?d(a,e):ca(a+“[”+(typeof +e==“object”||f.isArray(e)?b:“”)+“]”,e,c,d)});else +if(!c&&b!=null&&typeof b==“object”)for(var e in b)ca(a+“”,b,c,d);else d(a,b)}function +b_(a,c){var d,e,g=f.ajaxSettings.flatOptions||{};for(d in c)c!==b&&((g?a:e||(e={}))[d]=c);e&&f.extend(!0,a,e)}function b$(a,c,d,e,f,g){f=f||c.dataTypes,g=g||{},g=!0;var h=a,i=0,j=h?h.length:0,k=a===bT,l;for(;i(c,d,e),typeof +l==“string”&&(!k||g?l=b:(c.dataTypes.unshift(l),l=b$(a,c,d,e,l,g)));(k||!l)&&!g&&(l=b$(a,c,d,e,“*”,g));return +l}function bZ(a){return function(b,c){typeof +b!=“string”&&(c=b,b=“*”);if(f.isFunction©){var d=b.toLowerCase().split(bP),e=0,g=d.length,h,i,j;for(;e,j=/^+/.test(h),j&&(h=h.substr(1)||“*”),i=a=a||[],i©}}}function +bC(a,b,c){var +d=b===“width”?a.offsetWidth:a.offsetHeight,e=b===“width”?bx:by,g=0,h=e.length;if(d>0){if(c!==“border”)for(;g))||0),c===“margin”?d+=parseFloat(f.css(a,c+e))||0:d-=parseFloat(f.css(a,“border”+e+“Width”))||0;return +d+“px”}d=bz(a,b,b);if(d<0||d==null)d=a.style||0;d=parseFloat(d)||0;if©for(;g))||0,c!==“padding”&&(d+=parseFloat(f.css(a,“border”+e+“Width”))||0),c===“margin”&&(d+=parseFloat(f.css(a,c+e))||0);return +d+“px”}function +bp(a,b){b.src?f.ajax({url:b.src,async:!1,dataType:“script”}):f.globalEval((b.text||b.textContent||b.innerHTML||“”).replace(bf,“ +$0 ”)),b.parentNode&&b.parentNode.removeChild(b)}function +bo(a){var +b=c.createElement(“div”);bh.appendChild(b),b.innerHTML=a.outerHTML;return +b.firstChild}function bn(a){var +b=(a.nodeName||“”).toLowerCase();b===“input”?bm(a):b!==“script”&&typeof +a.getElementsByTagName!=“undefined”&&f.grep(a.getElementsByTagName(“input”),bm)}function +bm(a){if(a.type===“checkbox”||a.type===“radio”)a.defaultChecked=a.checked}function +bl(a){return typeof +a.getElementsByTagName!=“undefined”?a.getElementsByTagName(“*”):typeof +a.querySelectorAll!=“undefined”?a.querySelectorAll(“*”):[]}function +bk(a,b){var +c;if(b.nodeType===1){b.clearAttributes&&b.clearAttributes(),b.mergeAttributes&&b.mergeAttributes(a),c=b.nodeName.toLowerCase();if(c===“object”)b.outerHTML=a.outerHTML;else +if(c!==“input”||a.type!==“checkbox”&&a.type!==“radio”){if(c===“option”)b.selected=a.defaultSelected;else +if(c===“input”||c===“textarea”)b.defaultValue=a.defaultValue}else +a.checked&&(b.defaultChecked=b.checked=a.checked),b.value!==a.value&&(b.value=a.value);b.removeAttribute(f.expando)}}function +bj(a,b){if(b.nodeType===1&&!!f.hasData(a)){var +c,d,e,g=f._data(a),h=f._data(b,g),i=g.events;if(i){delete +h.handle,h.events={};for(c in i)for(d=0,e=i.length;d[d].namespace?“.”:“”)+i[d].namespace,i[d],i[d].data)}h.data&&(h.data=f.extend({},h.data))}}function +bi(a,b){return f.nodeName(a,“table”)?a.getElementsByTagName(“tbody”)||a.appendChild(a.ownerDocument.createElement(“tbody”)):a}function +U(a){var +b=V.split(“|”),c=a.createDocumentFragment();if(c.createElement)while(b.length)c.createElement(b.pop());return +c}function T(a,b,c){b=b||0;if(f.isFunction(b))return +f.grep(a,function(a,d){var e=!!b.call(a,d,a);return +e===c});if(b.nodeType)return f.grep(a,function(a,d){return +a===b===c});if(typeof b==“string”){var d=f.grep(a,function(a){return +a.nodeType===1});if(O.test(b))return +f.filter(b,d,!c);b=f.filter(b,d)}return f.grep(a,function(a,d){return +f.inArray(a,b)>=0===c})}function +S(a){return!a||!a.parentNode||a.parentNode.nodeType===11}function +K(){return!0}function J(){return!1}function n(a,b,c){var +d=b+“defer”,e=b+“queue”,g=b+“mark”,h=f._data(a,d);h&&(c===“queue”||!f._data(a,e))&&(c===“mark”||!f._data(a,g))&&setTimeout(function(){!f._data(a,e)&&!f._data(a,g)&&(f.removeData(a,d,!0),h.fire())},0)}function +m(a){for(var b in a){if(b===“data”&&f.isEmptyObject(a))continue;if(b!==“toJSON”)return!1}return!0}function +l(a,c,d){if(d===b&&a.nodeType===1){var +e=“data-”+c.replace(k,“-$1”).toLowerCase();d=a.getAttribute(e);if(typeof +d==“string”){try{d=d===“true”?!0:d===“false”?!1:d===“null”?null:f.isNumeric(d)?parseFloat(d):j.test(d)?f.parseJSON(d):d}catch(g){}f.data(a,c,d)}else +d=b}return d}function h(a){var b=g={},c,d;a=a.split(/s+/);for(c=0,d=a.length;c]=!0;return +b}var c=a.document,d=a.navigator,e=a.location,f=function(){function +J(){if(!e.isReady){try{c.documentElement.doScroll(“left”)}catch(a){setTimeout(J,1);return}e.ready()}}var +e=function(a,b){return new e.fn.init(a,b,h)},f=a.jQuery,g=a.$,h,i=/^(?:*(<[”>wW]+>)*$|#([w-]*)$)/,j=/S/,k=/^s+/,l=/s+$/,m=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,n=/^,:{}s]*$/,o=/\(?:|u{4})/g,p=/“*”|true|false|null|-?d+(?:.d*)?(?:[+-]?d+)?/g,q=/(?:^|:|,)(?:s*[)+/g,r=/(webkit)[ +/]([w.]+)/,s=/(opera)(?:.*version)?[ /]([w.]+)/,t=/(msie) +([w.]+)/,u=/(mozilla)(?:.*? rv:(+))?/,v=/-(|[0-9])/ig,w=/^-ms-/,x=function(a,b){return(b+“”).toUpperCase()},y=d.userAgent,z,A,B,C=Object.prototype.toString,D=Object.prototype.hasOwnProperty,E=Array.prototype.push,F=Array.prototype.slice,G=String.prototype.trim,H=Array.prototype.indexOf,I={};e.fn=e.prototype={constructor:e,init:function(a,d,f){var +g,h,j,k;if(!a)return this;if(a.nodeType){this.context=this=a,this.length=1;return +this}if(a===“body”&&!d&&c.body){this.context=c,this=c.body,this.selector=a,this.length=1;return +this}if(typeof a==“string”){a.charAt(0)!==“<"||a.charAt(a.length-1)!==">”||a.length<3?g=i.exec(a):g=;if(g&&(g||!d)){if(g){d=d instanceof e?d:d,k=d?d.ownerDocument||d:c,j=m.exec(a),j?e.isPlainObject(d)?(a=[c.createElement(j)],e.fn.attr.call(a,d,!0)):a=[k.createElement(j)]:(j=e.buildFragment([g],[k]),a=(j.cacheable?e.clone(j.fragment):j.fragment).childNodes);return +e.merge(this,a)}h=c.getElementById(g);if(h&&h.parentNode){if(h.id!==g)return f.find(a);this.length=1,this=h}this.context=c,this.selector=a;return +this}return!d||d.jquery?(d||f).find(a):this.constructor(d).find(a)}if(e.isFunction(a))return +f.ready(a);a.selector!==b&&(this.selector=a.selector,this.context=a.context);return +e.makeArray(a,this)},selector:“”,jquery:“1.7.1”,length:0,size:function(){return +this.length},toArray:function(){return +F.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this:this},pushStack:function(a,b,c){var +d=this.constructor();e.isArray(a)?E.apply(d,a):e.merge(d,a),d.prevObject=this,d.context=this.context,b===“find”?d.selector=this.selector+(this.selector?“ +”:“”)+c:b&&(d.selector=this.selector+“.”b“(”c“)”);return +d},each:function(a,b){return +e.each(this,a,b)},ready:function(a){e.bindReady(),A.add(a);return +this},eq:function(a){a=+a;return +a===-1?this.slice(a):this.slice(a,a+1)},first:function(){return +this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return +this.pushStack(F.apply(this,arguments),“slice”,F.call(arguments).join(“,”))},map:function(a){return +this.pushStack(e.map(this,function(b,c){return +a.call(b,c,b)}))},end:function(){return +this.prevObject||this.constructor(null)},push:E,sort:[].sort,splice:.splice},e.fn.init.prototype=e.fn,e.extend=e.fn.extend=function(){var +a,c,d,f,g,h,i=arguments||{},j=1,k=arguments.length,l=!1;typeof +i==“boolean”&&(l=i,i=arguments||{},j=2),typeof +i!=“object”&&!e.isFunction(i)&&(i={}),k===j&&(i=this,–j);for(;j)!=null)for(c +in a){d=i,f=a;if(i===f)continue;l&&f&&(e.isPlainObject(f)||(g=e.isArray(f)))?(g?(g=!1,h=d&&e.isArray(d)?d:[]):h=d&&e.isPlainObject(d)?d:{},i=e.extend(l,h,f)):f!==b&&(i=f)}return +i},e.extend({noConflict:function(b){a.$===e&&(a.$=g),b&&a.jQuery===e&&(a.jQuery=f);return +e},isReady:!1,readyWait:1,holdReady:function(a){a?e.readyWait++:e.ready(!0)},ready:function(a){if(a===!0&&!–e.readyWait||a!==!0&&!e.isReady){if(!c.body)return +setTimeout(e.ready,1);e.isReady=!0;if(a!==!0&&–e.readyWait>0)return;A.fireWith(c,),e.fn.trigger&&e©.trigger(“ready”).off(“ready”)}},bindReady:function(){if(!A){A=e.Callbacks(“once +memory”);if(c.readyState===“complete”)return +setTimeout(e.ready,1);if(c.addEventListener)c.addEventListener(“DOMContentLoaded”,B,!1),a.addEventListener(“load”,e.ready,!1);else +if(c.attachEvent){c.attachEvent(“onreadystatechange”,B),a.attachEvent(“onload”,e.ready);var +b=!1;try{b=a.frameElement==null}catch(d){}c.documentElement.doScroll&&b&&J()}}},isFunction:function(a){return +e.type(a)===“function”},isArray:Array.isArray||function(a){return +e.type(a)===“array”},isWindow:function(a){return a&&typeof +a==“object”&&“setInterval”in +a},isNumeric:function(a){return!isNaN(parseFloat(a))&&isFinite(a)},type:function(a){return +a==null?String(a):I||“object”},isPlainObject:function(a){if(!a||e.type(a)!==“object”||a.nodeType||e.isWindow(a))return!1;try{if(a.constructor&&!D.call(a,“constructor”)&&!D.call(a.constructor.prototype,“isPrototypeOf”))return!1}catch©{return!1}var +d;for(d in a);return d===b||D.call(a,d)},isEmptyObject:function(a){for(var +b in a)return!1;return!0},error:function(a){throw new +Error(a)},parseJSON:function(b){if(typeof b!=“string”||!b)return +null;b=e.trim(b);if(a.JSON&&a.JSON.parse)return +a.JSON.parse(b);if(n.test(b.replace(o,“@”).replace(p,“]”).replace(q,“”)))return(new +Function(“return ”+b))();e.error(“Invalid JSON: +”+b)},parseXML:function©{var d,f;try{a.DOMParser?(f=new +DOMParser,d=f.parseFromString(c,“text/xml”)):(d=new +ActiveXObject(“Microsoft.XMLDOM”),d.async=“false”,d.loadXML©)}catch(g){d=b}(!d||!d.documentElement||d.getElementsByTagName(“parsererror”).length)&&e.error(“Invalid +XML: ”+c);return +d},noop:function(){},globalEval:function(b){b&&j.test(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return +a.replace(w,“ms-”).replace(v,x)},nodeName:function(a,b){return +a.nodeName&&a.nodeName.toUpperCase()===b.toUpperCase()},each:function(a,c,d){var +f,g=0,h=a.length,i=h===b||e.isFunction(a);if(d){if(i){for(f in a)if(c.apply(a,d)===!1)break}else for(;g,d)===!1)break}else if(i){for(f in a)if(c.call(a,f,a)===!1)break}else for(;g,g,a)===!1)break;return +a},trim:G?function(a){return a==null?“”:G.call(a)}:function(a){return +a==null?“”:(a+“”).replace(k,“”).replace(l,“”)},makeArray:function(a,b){var +c=b||[];if(a!=null){var +d=e.type(a);a.length==null||d===“string”||d===“function”||d===“regexp”||e.isWindow(a)?E.call(c,a):e.merge(c,a)}return +c},inArray:function(a,b,c){var d;if(b){if(H)return +H.call(b,a,c);d=b.length,c=c?c<0?Math.max(0,d+c):c:0;for(;c<d;c++)if(c +in b&&b===a)return c}return-1},merge:function(a,c){var +d=a.length,e=0;if(typeof c.length==“number”)for(var f=c.length;e=c;else while(c!==b)a=c;a.length=d;return a},grep:function(a,b,c){var +d=[],e;c=!!c;for(var f=0,g=a.length;f,f),c!==e&&d.push(a);return d},map:function(a,c,d){var +f,g,h=[],i=0,j=a.length,k=a instanceof e||j!==b&&typeof j==“number”&&(j>0&&a&&a||j===0||e.isArray(a));if(k)for(;i,i,d),f!=null&&(h=f);else for(g in a)f=c(a,g,d),f!=null&&(h=f);return +h.concat.apply([],h)},guid:1,proxy:function(a,c){if(typeof c==“string”){var +d=a;c=a,a=d}if(!e.isFunction(a))return b;var +f=F.call(arguments,2),g=function(){return +a.apply(c,f.concat(F.call(arguments)))};g.guid=a.guid=a.guid||g.guid||e.guid++;return +g},access:function(a,c,d,f,g,h){var i=a.length;if(typeof +c==“object”){for(var j in c)e.access(a,j,c,f,g,d);return +a}if(d!==b){f=!h&&f&&e.isFunction(d);for(var k=0;k,c,f?d.call(a,k,g(a,c)):d,h);return a}return i?g(a,c):b},now:function(){return(new +Date).getTime()},uaMatch:function(a){a=a.toLowerCase();var b=r.exec(a)||s.exec(a)||t.exec(a)||a.indexOf(“compatible”)<0&&u.exec(a)||[];return{browser:b||“”,version:b||“0”}},sub:function(){function a(b,c){return new +a.fn.init(b,c)}e.extend(!0,a,this),a.superclass=this,a.fn=a.prototype=this(),a.fn.constructor=a,a.sub=this.sub,a.fn.init=function(d,f){f&&f +instanceof e&&!(f instanceof a)&&(f=a(f));return +e.fn.init.call(this,d,f,b)},a.fn.init.prototype=a.fn;var b=a©;return +a},browser:{}}),e.each(“Boolean Number String Function Array Date RegExp +Object”.split(“ ”),function(a,b){I[“[object +”b“]”]=b.toLowerCase()}),z=e.uaMatch(y),z.browser&&(e.browser=!0,e.browser.version=z.version),e.browser.webkit&&(e.browser.safari=!0),j.test(“ ”)&&(k=/^+/,l=/+$/),h=e©,c.addEventListener?B=function(){c.removeEventListener(“DOMContentLoaded”,B,!1),e.ready()}:c.attachEvent&&(B=function(){c.readyState===“complete”&&(c.detachEvent(“onreadystatechange”,B),e.ready())});return +e}(),g={};f.Callbacks=function(a){a=a?g||h(a):{};var c=[],d=,e,i,j,k,l,m=function(b){var d,e,g,h,i;for(d=0,e=b.length;d,h=f.type(g),h===“array”?m(g):h===“function”&&(!a.unique||!o.has(g))&&c.push(g)},n=function(b,f){f=f||[],e=!a.memory||,i=!0,l=j||0,j=0,k=c.length;for(;c&&l.apply(b,f)===!1&&a.stopOnFalse){e=!0;break}i=!1,c&&(a.once?e===!0?o.disable():c=[]:d&&d.length&&(e=d.shift(),o.fireWith(e,e)))},o={add:function(){if©{var a=c.length;m(arguments),i?k=c.length:e&&e!==!0&&(j=a,n(e,e))}return this},remove:function(){if©{var +b=arguments,d=0,e=b.length;for(;d<e;d++)for(var f=0;f===c){i&&f<=k&&(k–,f<=l&&l–),c.splice(f–,1);if(a.unique)break}}return +this},has:function(a){if©{var b=0,d=c.length;for(;b)return!0}return!1},empty:function(){c=[];return +this},disable:function(){c=d=e=b;return +this},disabled:function(){return!c},lock:function(){d=b,(!e||e===!0)&&o.disable();return +this},locked:function(){return!d},fireWith:function(b,c){d&&(i?a.once||d.push():(!a.once||!e)&&n(b,c));return +this},fire:function(){o.fireWith(this,arguments);return +this},fired:function(){return!!e}};return o};var +i=[].slice;f.extend({Deferred:function(a){var b=f.Callbacks(“once +memory”),c=f.Callbacks(“once +memory”),d=f.Callbacks(“memory”),e=“pending”,g={resolve:b,reject:c,notify:d},h={done:b.add,fail:c.add,progress:d.add,state:function(){return +e},isResolved:b.fired,isRejected:c.fired,then:function(a,b,c){i.done(a).fail(b).progress©;return +this},always:function(){i.done.apply(i,arguments).fail.apply(i,arguments);return +this},pipe:function(a,b,c){return f.Deferred(function(d){f.each({done:,fail:,progress:},function(a,b){var c=b,e=b,g;f.isFunction©?i(function(){g=c.apply(this,arguments),g&&f.isFunction(g.promise)?g.promise().then(d.resolve,d.reject,d.notify):d(this===i?d:this,)}):i(d)})}).promise()},promise:function(a){if(a==null)a=h;else +for(var b in h)a=h;return +a}},i=h.promise({}),j;for(j in g)i=g.fire,i=g.fireWith;i.done(function(){e=“resolved”},c.disable,d.lock).fail(function(){e=“rejected”},b.disable,d.lock),a&&a.call(i,i);return +i},when:function(a){function m(a){return function(b){e=arguments.length>1?i.call(arguments,0):b,j.notifyWith(k,e)}}function +l(a){return function©{b=arguments.length>1?i.call(arguments,0):c,–g||j.resolveWith(j,b)}}var +b=i.call(arguments,0),c=0,d=b.length,e=Array(d),g=d,h=d,j=d<=1&&a&&f.isFunction(a.promise)?a:f.Deferred(),k=j.promise();if(d>1){for(;c&&b.promise&&f.isFunction(b.promise)?b.promise().then(l©,j.reject,m©):–g;g||j.resolveWith(j,b)}else +j!==a&&j.resolveWith(j,d?:[]);return +k}}),f.support=function(){var +b,d,e,g,h,i,j,k,l,m,n,o,p,q=c.createElement(“div”),r=c.documentElement;q.setAttribute(“className”,“t”),q.innerHTML=“ +<link/><table></table><a href='/a' +style='top:1px;float:left;opacity:.55;'>a</a><input type=‘checkbox’/>”,d=q.getElementsByTagName(“*”),e=q.getElementsByTagName(“a”);if(!d||!d.length||!e)return{};g=c.createElement(“select”),h=g.appendChild(c.createElement(“option”)),i=q.getElementsByTagName(“input”),b={leadingWhitespace:q.firstChild.nodeType===3,tbody:!q.getElementsByTagName(“tbody”).length,htmlSerialize:!!q.getElementsByTagName(“link”).length,style:/top/.test(e.getAttribute(“style”)),hrefNormalized:e.getAttribute(“href”)===“/a”,opacity:/^0.55/.test(e.style.opacity),cssFloat:!!e.style.cssFloat,checkOn:i.value===“on”,optSelected:h.selected,getSetAttribute:q.className!==“t”,enctype:!!c.createElement(“form”).enctype,html5Clone:c.createElement(“nav”).cloneNode(!0).outerHTML!==“<:nav></:nav>”,submitBubbles:!0,changeBubbles:!0,focusinBubbles:!1,deleteExpando:!0,noCloneEvent:!0,inlineBlockNeedsLayout:!1,shrinkWrapBlocks:!1,reliableMarginRight:!0},i.checked=!0,b.noCloneChecked=i.cloneNode(!0).checked,g.disabled=!0,b.optDisabled=!h.disabled;try{delete +q.test}catch(s){b.deleteExpando=!1}!q.addEventListener&&q.attachEvent&&q.fireEvent&&(q.attachEvent(“onclick”,function(){b.noCloneEvent=!1}),q.cloneNode(!0).fireEvent(“onclick”)),i=c.createElement(“input”),i.value=“t”,i.setAttribute(“type”,“radio”),b.radioValue=i.value===“t”,i.setAttribute(“checked”,“checked”),q.appendChild(i),k=c.createDocumentFragment(),k.appendChild(q.lastChild),b.checkClone=k.cloneNode(!0).cloneNode(!0).lastChild.checked,b.appendChecked=i.checked,k.removeChild(i),k.appendChild(q),q.innerHTML=“”,a.getComputedStyle&&(j=c.createElement(“div”),j.style.width=“0”,j.style.marginRight=“0”,q.style.width=“2px”,q.appendChild(j),b.reliableMarginRight=(parseInt((a.getComputedStyle(j,null)||{marginRight:0}).marginRight,10)||0)===0);if(q.attachEvent)for(o +in{submit:1,change:1,focusin:1})n=“on”+o,p=n in +q,p||(q.setAttribute(n,“return;”),p=typeof q==“function”),b=p;k.removeChild(q),k=g=h=j=q=i=null,f(function(){var +a,d,e,g,h,i,j,k,m,n,o,r=c.getElementsByTagName(“body”);!r||(j=1,k=“position:absolute;top:0;left:0;width:1px;height:1px;margin:0;”,m=“visibility:hidden;border:0;”,n=“style='”k“border:5px +solid #000;padding:0;'”,o=“<div +”n“><div></div></div>”+“<table +”n“ cellpadding='0' +cellspacing='0'>”+“<tr><td></td></tr></table>”,a=c.createElement(“div”),a.style.cssText=m+“width:0;height:0;position:static;top:0;margin-top:”j“px”,r.insertBefore(a,r.firstChild),q=c.createElement(“div”),a.appendChild(q),q.innerHTML=“<table><tr><td +style=‘padding:0;border:0;display:none’>t”,l=q.getElementsByTagName(“td”),p=l.offsetHeight===0,l.style.display=“”,l.style.display=“none”,b.reliableHiddenOffsets=p&&l.offsetHeight===0,q.innerHTML=“”,q.style.width=q.style.paddingLeft=“1px”,f.boxModel=b.boxModel=q.offsetWidth===2,typeof +q.style.zoom!=“undefined”&&(q.style.display=“inline”,q.style.zoom=1,b.inlineBlockNeedsLayout=q.offsetWidth===2,q.style.display=“”,q.innerHTML=“<div +style='width:4px;'></div>”,b.shrinkWrapBlocks=q.offsetWidth!==2),q.style.cssText=k+m,q.innerHTML=o,d=q.firstChild,e=d.firstChild,h=d.nextSibling.firstChild.firstChild,i={doesNotAddBorder:e.offsetTop!==5,doesAddBorderForTableAndCells:h.offsetTop===5},e.style.position=“fixed”,e.style.top=“20px”,i.fixedPosition=e.offsetTop===20||e.offsetTop===15,e.style.position=e.style.top=“”,d.style.overflow=“hidden”,d.style.position=“relative”,i.subtractsBorderForOverflowNotVisible=e.offsetTop===-5,i.doesNotIncludeMarginInBodyOffset=r.offsetTop!==j,r.removeChild(a),q=a=null,f.extend(b,i))});return +b}();var j=/^(?:{.*}|[.*])$/,k=/()/g;f.extend({cache:{},uuid:0,expando:“jQuery”+(f.fn.jquery+Math.random()).replace(/D/g,“”),noData:{embed:!0,object:“clsid:D27CDB6E-AE6D-11cf-96B8-444553540000”,applet:!0},hasData:function(a){a=a.nodeType?f.cache[a]:a;return!!a&&!m(a)},data:function(a,c,d,e){if(!!f.acceptData(a)){var +g,h,i,j=f.expando,k=typeof c==“string”,l=a.nodeType,m=l?f.cache:a,n=l?a:a&&j,o=c===“events”;if((!n||!m||!o&&!e&&!m.data)&&k&&d===b)return;n||(l?a=n=++f.uuid:n=j),m||(m={},l||(m.toJSON=f.noop));if(typeof c==“object”||typeof c==“function”)e?m=f.extend(m,c):m.data=f.extend(m.data,c);g=h=m,e||(h.data||(h.data={}),h=h.data),d!==b&&(h=d);if(o&&!h)return g.events;k?(i=h,i==null&&(i=h)):i=h;return +i}},removeData:function(a,b,c){if(!!f.acceptData(a)){var d,e,g,h=f.expando,i=a.nodeType,j=i?f.cache:a,k=i?a:h;if(!j)return;if(b){d=c?j:j.data;if(d){f.isArray(b)||(b in d?b=:(b=f.camelCase(b),b in d?b=:b=b.split(“ +”)));for(e=0,g=b.length;e<g;e++)delete d[b];if(!(c?m:f.isEmptyObject)(d))return}}if(!c){delete j.data;if(!m(j))return}f.support.deleteExpando||!j.setInterval?delete +j:j=null,i&&(f.support.deleteExpando?delete a:a.removeAttribute?a.removeAttribute(h):a=null)}},_data:function(a,b,c){return +f.data(a,b,c,!0)},acceptData:function(a){if(a.nodeName){var b=f.noData;if(b)return +b!==!0&&a.getAttribute(“classid”)===b}return!0}}),f.fn.extend({data:function(a,c){var +d,e,g,h=null;if(typeof a==“undefined”){if(this.length){h=f.data(this);if(this.nodeType===1&&!f._data(this,“parsedAttrs”)){e=this.attributes;for(var i=0,j=e.length;i.name,g.indexOf(“data-”)===0&&(g=f.camelCase(g.substring(5)),l(this,g,h));f._data(this,“parsedAttrs”,!0)}}return +h}if(typeof a==“object”)return this.each(function(){f.data(this,a)});d=a.split(“.”),d=d?“.”+d:“”;if(c===b){h=this.triggerHandler(“getData”+d+“!”,[d]),h===b&&this.length&&(h=f.data(this,a),h=l(this,a,h));return h===b&&d?this.data(d):h}return this.each(function(){var b=f(this),e=[d,c];b.triggerHandler(“setData”+d+“!”,e),f.data(this,a,c),b.triggerHandler(“changeData”+d+“!”,e)})},removeData:function(a){return +this.each(function(){f.removeData(this,a)})}}),f.extend({_mark:function(a,b){a&&(b=(b||“fx”)+“mark”,f._data(a,b,(f._data(a,b)||0)+1))},_unmark:function(a,b,c){a!==!0&&(c=b,b=a,a=!1);if(b){c=c||“fx”;var +d=c+“mark”,e=a?0:(f._data(b,d)||1)-1;e?f._data(b,d,e):(f.removeData(b,d,!0),n(b,c,“mark”))}},queue:function(a,b,c){var +d;if(a){b=(b||“fx”)+“queue”,d=f._data(a,b),c&&(!d||f.isArray©?d=f._data(a,b,f.makeArray©):d.push©);return +d||[]}},dequeue:function(a,b){b=b||“fx”;var +c=f.queue(a,b),d=c.shift(),e={};d===“inprogress”&&(d=c.shift()),d&&(b===“fx”&&c.unshift(“inprogress”),f._data(a,b+“.run”,e),d.call(a,function(){f.dequeue(a,b)},e)),c.length||(f.removeData(a,b+“queue +”b“.run”,!0),n(a,b,“queue”))}}),f.fn.extend({queue:function(a,c){typeof +a!=“string”&&(c=a,a=“fx”);if(c===b)return f.queue(this,a);return this.each(function(){var b=f.queue(this,a,c);a===“fx”&&b!==“inprogress”&&f.dequeue(this,a)})},dequeue:function(a){return +this.each(function(){f.dequeue(this,a)})},delay:function(a,b){a=f.fx?f.fx.speeds||a:a,b=b||“fx”;return +this.queue(b,function(b,c){var +d=setTimeout(b,a);c.stop=function(){clearTimeout(d)}})},clearQueue:function(a){return +this.queue(a||“fx”,[])},promise:function(a,c){function m(){–h||d.resolveWith(e,)}typeof +a!=“string”&&(c=a,a=b),a=a||“fx”;var d=f.Deferred(),e=this,g=e.length,h=1,i=a+“defer”,j=a+“queue”,k=a+“mark”,l;while(g–)if(l=f.data(e,i,b,!0)||(f.data(e,j,b,!0)||f.data(e,k,b,!0))&&f.data(e,i,f.Callbacks(“once +memory”),!0))h++,l.add(m);m();return d.promise()}});var o=//g,p=/s+/,q=/r/g,r=/^(?:button|input)$/i,s=/^(?:button|input|object|select|textarea)$/i,t=/^a(?:rea)?$/i,u=/^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i,v=f.support.getSetAttribute,w,x,y;f.fn.extend({attr:function(a,b){return +f.access(this,a,b,!0,f.attr)},removeAttr:function(a){return +this.each(function(){f.removeAttr(this,a)})},prop:function(a,b){return +f.access(this,a,b,!0,f.prop)},removeProp:function(a){a=f.propFix||a;return this.each(function(){try{this=b,delete this}catch©{}})},addClass:function(a){var +b,c,d,e,g,h,i;if(f.isFunction(a))return +this.each(function(b){f(this).addClass(a.call(this,b,this.className))});if(a&&typeof +a==“string”){b=a.split(p);for(c=0,d=this.length;c<d;c++){e=this;if(e.nodeType===1)if(!e.className&&b.length===1)e.className=a;else{g=“ +”e.className“ ”;for(h=0,i=b.length;h<i;h++)~g.indexOf(“ +”+b+“ ”)||(g+=b+“ +”);e.className=f.trim(g)}}}return this},removeClass:function(a){var +c,d,e,g,h,i,j;if(f.isFunction(a))return +this.each(function(b){f(this).removeClass(a.call(this,b,this.className))});if(a&&typeof +a==“string”||a===b){c=(a||“”).split(p);for(d=0,e=this.length;d<e;d++){g=this;if(g.nodeType===1&&g.className)if(a){h=(“ +”g.className“ ”).replace(o,“ +”);for(i=0,j=c.length;i<j;i++)h=h.replace(“ ”+c+“ ”,“ +”);g.className=f.trim(h)}else g.className=“”}}return +this},toggleClass:function(a,b){var c=typeof a,d=typeof +b==“boolean”;if(f.isFunction(a))return +this.each(function©{f(this).toggleClass(a.call(this,c,this.className,b),b)});return +this.each(function(){if(c===“string”){var e,g=0,h=f(this),i=b,j=a.split(p);while(e=j)i=d?i:!h.hasClass(e),h(e)}else +if(c===“undefined”||c===“boolean”)this.className&&f._data(this,“__className__”,this.className),this.className=this.className||a===!1?“”:f._data(this,“__className__”)||“”})},hasClass:function(a){var +b=“ ”a“ ”,c=0,d=this.length;for(;c.nodeType===1&&(“ +”+this.className+“ ”).replace(o,“ +”).indexOf(b)>-1)return!0;return!1},val:function(a){var c,d,e,g=this;{if(!!arguments.length){e=f.isFunction(a);return +this.each(function(d){var +g=f(this),h;if(this.nodeType===1){e?h=a.call(this,d,g.val()):h=a,h==null?h=“”:typeof +h==“number”?h+=“”:f.isArray(h)&&(h=f.map(h,function(a){return +a==null?“”:a+“”})),c=f.valHooks||f.valHooks;if(!c||!(“set”in +c)||c.set(this,h,“value”)===b)this.value=h}})}if(g){c=f.valHooks||f.valHooks;if(c&&“get”in +c&&(d=c.get(g,“value”))!==b)return d;d=g.value;return typeof +d==“string”?d.replace(q,“”):d==null?“”:d}}}}),f.extend({valHooks:{option:{get:function(a){var +b=a.attributes.value;return!b||b.specified?a.value:a.text}},select:{get:function(a){var +b,c,d,e,g=a.selectedIndex,h=[],i=a.options,j=a.type===“select-one”;if(g<0)return +null;c=j?g:0,d=j?g+1:i.length;for(;c<d;c++){e=i;if(e.selected&&(f.support.optDisabled?!e.disabled:e.getAttribute(“disabled”)===null)&&(!e.parentNode.disabled||!f.nodeName(e.parentNode,“optgroup”))){b=f(e).val();if(j)return +b;h.push(b)}}if(j&&!h.length&&i.length)return f(i).val();return h},set:function(a,b){var +c=f.makeArray(b);f(a).find(“option”).each(function(){this.selected=f.inArray(f(this).val(),c)>=0}),c.length||(a.selectedIndex=-1);return +c}}},attrFn:{val:!0,css:!0,html:!0,text:!0,data:!0,width:!0,height:!0,offset:!0},attr:function(a,c,d,e){var +g,h,i,j=a.nodeType;if(!!a&&j!==3&&j!==8&&j!==2){if(e&&c +in f.attrFn)return f(a)(d);if(typeof +a.getAttribute==“undefined”)return f.prop(a,c,d);i=j!==1||!f.isXMLDoc(a),i&&(c=c.toLowerCase(),h=f.attrHooks||(u.test©?x:w));if(d!==b){if(d===null){f.removeAttr(a,c);return}if(h&&“set”in +h&&i&&(g=h.set(a,d,c))!==b)return +g;a.setAttribute(c,“”+d);return d}if(h&&“get”in +h&&i&&(g=h.get(a,c))!==null)return +g;g=a.getAttribute©;return g===null?b:g}},removeAttr:function(a,b){var +c,d,e,g,h=0;if(b&&a.nodeType===1){d=b.toLowerCase().split(p),g=d.length;for(;h,e&&(c=f.propFix||e,f.attr(a,e,“”),a.removeAttribute(v?e:c),u.test(e)&&c +in a&&(a=!1))}},attrHooks:{type:{set:function(a,b){if(r.test(a.nodeName)&&a.parentNode)f.error(“type +property can't be changed”);else +if(!f.support.radioValue&&b===“radio”&&f.nodeName(a,“input”)){var +c=a.value;a.setAttribute(“type”,b),c&&(a.value=c);return +b}}},value:{get:function(a,b){if(w&&f.nodeName(a,“button”))return +w.get(a,b);return b in +a?a.value:null},set:function(a,b,c){if(w&&f.nodeName(a,“button”))return +w.set(a,b,c);a.value=b}}},propFix:{tabindex:“tabIndex”,readonly:“readOnly”,“for”:“htmlFor”,“class”:“className”,maxlength:“maxLength”,cellspacing:“cellSpacing”,cellpadding:“cellPadding”,rowspan:“rowSpan”,colspan:“colSpan”,usemap:“useMap”,frameborder:“frameBorder”,contenteditable:“contentEditable”},prop:function(a,c,d){var +e,g,h,i=a.nodeType;if(!!a&&i!==3&&i!==8&&i!==2){h=i!==1||!f.isXMLDoc(a),h&&(c=f.propFix||c,g=f.propHooks);return d!==b?g&&“set”in g&&(e=g.set(a,d,c))!==b?e:a=d:g&&“get”in g&&(e=g.get(a,c))!==null?e:a}},propHooks:{tabIndex:{get:function(a){var +c=a.getAttributeNode(“tabindex”);return +c&&c.specified?parseInt(c.value,10):s.test(a.nodeName)||t.test(a.nodeName)&&a.href?0:b}}}}),f.attrHooks.tabindex=f.propHooks.tabIndex,x={get:function(a,c){var +d,e=f.prop(a,c);return e===!0||typeof +e!=“boolean”&&(d=a.getAttributeNode©)&&d.nodeValue!==!1?c.toLowerCase():b},set:function(a,b,c){var +d;b===!1?f.removeAttr(a,c):(d=f.propFix||c,d in a&&(a=!0),a.setAttribute(c,c.toLowerCase()));return +c}},v||(y={name:!0,id:!0},w=f.valHooks.button={get:function(a,c){var +d;d=a.getAttributeNode©;return d&&(y?d.nodeValue!==“”:d.specified)?d.nodeValue:b},set:function(a,b,d){var +e=a.getAttributeNode(d);e||(e=c.createAttribute(d),a.setAttributeNode(e));return +e.nodeValue=b+“”}},f.attrHooks.tabindex.set=w.set,f.each(,function(a,b){f.attrHooks=f.extend(f.attrHooks,{set:function(a,c){if(c===“”){a.setAttribute(b,“auto”);return +c}}})}),f.attrHooks.contenteditable={get:w.get,set:function(a,b,c){b===“”&&(b=“false”),w.set(a,b,c)}}),f.support.hrefNormalized||f.each(,function(a,c){f.attrHooks=f.extend(f.attrHooks,{get:function(a){var +d=a.getAttribute(c,2);return +d===null?b:d}})}),f.support.style||(f.attrHooks.style={get:function(a){return +a.style.cssText.toLowerCase()||b},set:function(a,b){return +a.style.cssText=“”+b}}),f.support.optSelected||(f.propHooks.selected=f.extend(f.propHooks.selected,{get:function(a){var +b=a.parentNode;b&&(b.selectedIndex,b.parentNode&&b.parentNode.selectedIndex);return +null}})),f.support.enctype||(f.propFix.enctype=“encoding”),f.support.checkOn||f.each(,function(){f.valHooks={get:function(a){return +a.getAttribute(“value”)===null?“on”:a.value}}}),f.each(,function(){f.valHooks=f.extend(f.valHooks,{set:function(a,b){if(f.isArray(b))return +a.checked=f.inArray(f(a).val(),b)>=0}})});var z=/^(?:textarea|input|select)$/i,A=/^(*)?(?:.(.+))?$/,B=/bhover(.S+)?b/,C=/^key/,D=/^(?:mouse|contextmenu)|click/,E=/^(?:focusinfocus|focusoutblur)$/,F=/^(w*)(?:#(+))?(?:.([w-]+))?$/,G=function(a){var +b=F.exec(a);b&&(b=(b||“”).toLowerCase(),b=b&&new RegExp(“(?:^|\s)”+b+“(?:\s|$)”));return b},H=function(a,b){var +c=a.attributes||{};return(!b||a.nodeName.toLowerCase()===b)&&(!b||(c.id||{}).value===b)&&(!b||b.test((c||{}).value))},I=function(a){return +f.event.special.hover?a:a.replace(B,“mouseenter$1 mouseleave$1”)}; +f.event={add:function(a,c,d,e,g){var +h,i,j,k,l,m,n,o,p,q,r,s;if(!(a.nodeType===3||a.nodeType===8||!c||!d||!(h=f._data(a)))){d.handler&&(p=d,d=p.handler),d.guid||(d.guid=f.guid++),j=h.events,j||(h.events=j={}),i=h.handle,i||(h.handle=i=function(a){return +typeof +f!=“undefined”&&(!a||f.event.triggered!==a.type)?f.event.dispatch.apply(i.elem,arguments):b},i.elem=a),c=f.trim(I©).split(“ +”);for(k=0;k<c.length;k++){l=A.exec(c)||[],m=l,n=(l||“”).split(“.”).sort(),s=f.event.special||{},m=(g?s.delegateType:s.bindType)||m,s=f.event.special||{},o=f.extend({type:m,origType:l,data:e,handler:d,guid:d.guid,selector:g,quick:G(g),namespace:n.join(“.”)},p),r=j;if(!r){r=j=[],r.delegateCount=0;if(!s.setup||s.setup.call(a,e,n,i)===!1)a.addEventListener?a.addEventListener(m,i,!1):a.attachEvent&&a.attachEvent(“on”+m,i)}s.add&&(s.add.call(a,o),o.handler.guid||(o.handler.guid=d.guid)),g?r.splice(r.delegateCount++,0,o):r.push(o),f.event.global=!0}a=null}},global:{},remove:function(a,b,c,d,e){var +g=f.hasData(a)&&f._data(a),h,i,j,k,l,m,n,o,p,q,r,s;if(!!g&&!!(o=g.events)){b=f.trim(I(b||“”)).split(“ +”);for(h=0;h<b.length;h++){i=A.exec(b)||[],j=k=i,l=i;if(!j){for(j in o)f.event.remove(a,j+b,c,d,!0);continue}p=f.event.special||{},j=(d?p.delegateType:p.bindType)||j,r=o||[],m=r.length,l=l?new +RegExp(“(^|\.)”+l.split(“.”).sort().join(“\.(?:.*\.)?”)+“(\.|$)”):null;for(n=0;n,(e||k===s.origType)&&(!c||c.guid===s.guid)&&(!l||l.test(s.namespace))&&(!d||d===s.selector||d===“**”&&s.selector)&&(r.splice(n–,1),s.selector&&r.delegateCount–,p.remove&&p.remove.call(a,s));r.length===0&&m!==r.length&&((!p.teardown||p.teardown.call(a,l)===!1)&&f.removeEvent(a,j,g.handle),delete +o)}f.isEmptyObject(o)&&(q=g.handle,q&&(q.elem=null),f.removeData(a,,!0))}},customEvent:{getData:!0,setData:!0,changeData:!0},trigger:function(c,d,e,g){if(!e||e.nodeType!==3&&e.nodeType!==8){var +h=c.type||c,i=[],j,k,l,m,n,o,p,q,r,s;if(E.test(h+f.event.triggered))return;h.indexOf(“!”)>=0&&(h=h.slice(0,-1),k=!0),h.indexOf(“.”)>=0&&(i=h.split(“.”),h=i.shift(),i.sort());if((!e||f.event.customEvent)&&!f.event.global)return;c=typeof c==“object”?c?c:new f.Event(h,c):new +f.Event(h),c.type=h,c.isTrigger=!0,c.exclusive=k,c.namespace=i.join(“.”),c.namespace_re=c.namespace?new +RegExp(“(^|\.)”+i.join(“\.(?:.*\.)?”)+“(\.|$)”):null,o=h.indexOf(“:”)<0?“on”+h:“”;if(!e){j=f.cache;for(l +in j)j.events&&j.events&&f.event.trigger(c,d,j.handle.elem,!0);return}c.result=b,c.target||(c.target=e),d=d!=null?f.makeArray(d):[],d.unshift©,p=f.event.special||{};if(p.trigger&&p.trigger.apply(e,d)===!1)return;r=[];if(!g&&!p.noBubble&&!f.isWindow(e)){s=p.delegateType||h,m=E.test(s+h)?e:e.parentNode,n=null;for(;m;m=m.parentNode)r.push(),n=m;n&&n===e.ownerDocument&&r.push()}for(l=0;l[0],c.type=r[1],q=(f._data(m,“events”)||{})[c.type]&&f._data(m,“handle”),q&&q.apply(m,d),q=o&&m,q&&f.acceptData(m)&&q.apply(m,d)===!1&&c.preventDefault();c.type=h,!g&&!c.isDefaultPrevented()&&(!p._default||p._default.apply(e.ownerDocument,d)===!1)&&(h!==“click”||!f.nodeName(e,“a”))&&f.acceptData(e)&&o&&e&&(h!==“focus”&&h!==“blur”||c.target.offsetWidth!==0)&&!f.isWindow(e)&&(n=e,n&&(e=null),f.event.triggered=h,e(),f.event.triggered=b,n&&(e=n));return +c.result}},dispatch:function©{c=f.event.fix(c||a.event);var +d=(f._data(this,“events”)||{})[c.type]||[],e=d.delegateCount,g=.slice.call(arguments,0),h=!c.exclusive&&!c.namespace,i=[],j,k,l,m,n,o,p,q,r,s,t;g=c,c.delegateTarget=this;if(e&&!c.target.disabled&&(!c.button||c.type!==“click”)){m=f(this),m.context=this.ownerDocument||this;for(l=c.target;l!=this;l=l.parentNode||this){o={},q=[],m=l;for(j=0;j,s=r.selector,o===b&&(o=r.quick?H(l,r.quick):m.is(s)),o&&q.push®;q.length&&i.push({elem:l,matches:q})}}d.length>e&&i.push({elem:this,matches:d.slice(e)});for(j=0;j<i.length&&!c.isPropagationStopped();j++){p=i,c.currentTarget=p.elem;for(k=0;k<p.matches.length&&!c.isImmediatePropagationStopped();k++){r=p.matches;if(h||!c.namespace&&!r.namespace||c.namespace_re&&c.namespace_re.test(r.namespace))c.data=r.data,c.handleObj=r,n=((f.event.special||{}).handle||r.handler).apply(p.elem,g),n!==b&&(c.result=n,n===!1&&(c.preventDefault(),c.stopPropagation()))}}return +c.result},props:“attrChange attrName relatedNode srcElement altKey bubbles +cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey +target timeStamp view which”.split(“ ”),fixHooks:{},keyHooks:{props:“char +charCode key keyCode”.split(“ +”),filter:function(a,b){a.which==null&&(a.which=b.charCode!=null?b.charCode:b.keyCode);return +a}},mouseHooks:{props:“button buttons clientX clientY fromElement offsetX +offsetY pageX pageY screenX screenY toElement”.split(“ +”),filter:function(a,d){var +e,f,g,h=d.button,i=d.fromElement;a.pageX==null&&d.clientX!=null&&(e=a.target.ownerDocument||c,f=e.documentElement,g=e.body,a.pageX=d.clientX+(f&&f.scrollLeft||g&&g.scrollLeft||0)-(f&&f.clientLeft||g&&g.clientLeft||0),a.pageY=d.clientY+(f&&f.scrollTop||g&&g.scrollTop||0)-(f&&f.clientTop||g&&g.clientTop||0)),!a.relatedTarget&&i&&(a.relatedTarget=i===a.target?d.toElement:i),!a.which&&h!==b&&(a.which=h&1?1:h&2?3:h&4?2:0);return +a}},fix:function(a){if(a)return a;var d,e,g=a,h=f.event.fixHooks||{},i=h.props?this.props.concat(h.props):this.props;a=f.Event(g);for(d=i.length;d;)e=i,a=g;a.target||(a.target=g.srcElement||c),a.target.nodeType===3&&(a.target=a.target.parentNode),a.metaKey===b&&(a.metaKey=a.ctrlKey);return +h.filter?h.filter(a,g):a},special:{ready:{setup:f.bindReady},load:{noBubble:!0},focus:{delegateType:“focusin”},blur:{delegateType:“focusout”},beforeunload:{setup:function(a,b,c){f.isWindow(this)&&(this.onbeforeunload=c)},teardown:function(a,b){this.onbeforeunload===b&&(this.onbeforeunload=null)}}},simulate:function(a,b,c,d){var +e=f.extend(new +f.Event,c,{type:a,isSimulated:!0,originalEvent:{}});d?f.event.trigger(e,null,b):f.event.dispatch.call(b,e),e.isDefaultPrevented()&&c.preventDefault()}},f.event.handle=f.event.dispatch,f.removeEvent=c.removeEventListener?function(a,b,c){a.removeEventListener&&a.removeEventListener(b,c,!1)}:function(a,b,c){a.detachEvent&&a.detachEvent(“on”+b,c)},f.Event=function(a,b){if(!(this +instanceof f.Event))return new f.Event(a,b);a&&a.type?(this.originalEvent=a,this.type=a.type,this.isDefaultPrevented=a.defaultPrevented||a.returnValue===!1||a.getPreventDefault&&a.getPreventDefault()?K:J):this.type=a,b&&f.extend(this,b),this.timeStamp=a&&a.timeStamp||f.now(),this=!0},f.Event.prototype={preventDefault:function(){this.isDefaultPrevented=K;var +a=this.originalEvent;!a||(a.preventDefault?a.preventDefault():a.returnValue=!1)},stopPropagation:function(){this.isPropagationStopped=K;var +a=this.originalEvent;!a||(a.stopPropagation&&a.stopPropagation(),a.cancelBubble=!0)},stopImmediatePropagation:function(){this.isImmediatePropagationStopped=K,this.stopPropagation()},isDefaultPrevented:J,isPropagationStopped:J,isImmediatePropagationStopped:J},f.each({mouseenter:“mouseover”,mouseleave:“mouseout”},function(a,b){f.event.special={delegateType:b,bindType:b,handle:function(a){var +c=this,d=a.relatedTarget,e=a.handleObj,g=e.selector,h;if(!d||d!==c&&!f.contains(c,d))a.type=e.origType,h=e.handler.apply(this,arguments),a.type=b;return +h}}}),f.support.submitBubbles||(f.event.special.submit={setup:function(){if(f.nodeName(this,“form”))return!1;f.event.add(this,“click._submit +keypress._submit”,function(a){var +c=a.target,d=f.nodeName(c,“input”)||f.nodeName(c,“button”)?c.form:b;d&&!d._submit_attached&&(f.event.add(d,“submit._submit”,function(a){this.parentNode&&!a.isTrigger&&f.event.simulate(“submit”,this.parentNode,a,!0)}),d._submit_attached=!0)})},teardown:function(){if(f.nodeName(this,“form”))return!1;f.event.remove(this,“._submit”)}}),f.support.changeBubbles||(f.event.special.change={setup:function(){if(z.test(this.nodeName)){if(this.type===“checkbox”||this.type===“radio”)f.event.add(this,“propertychange._change”,function(a){a.originalEvent.propertyName===“checked”&&(this._just_changed=!0)}),f.event.add(this,“click._change”,function(a){this._just_changed&&!a.isTrigger&&(this._just_changed=!1,f.event.simulate(“change”,this,a,!0))});return!1}f.event.add(this,“beforeactivate._change”,function(a){var +b=a.target;z.test(b.nodeName)&&!b._change_attached&&(f.event.add(b,“change._change”,function(a){this.parentNode&&!a.isSimulated&&!a.isTrigger&&f.event.simulate(“change”,this.parentNode,a,!0)}),b._change_attached=!0)})},handle:function(a){var +b=a.target;if(this!==b||a.isSimulated||a.isTrigger||b.type!==“radio”&&b.type!==“checkbox”)return +a.handleObj.handler.apply(this,arguments)},teardown:function(){f.event.remove(this,“._change”);return +z.test(this.nodeName)}}),f.support.focusinBubbles||f.each({focus:“focusin”,blur:“focusout”},function(a,b){var +d=0,e=function(a){f.event.simulate(b,a.target,f.event.fix(a),!0)};f.event.special={setup:function(){d++===0&&c.addEventListener(a,e,!0)},teardown:function(){–d===0&&c.removeEventListener(a,e,!0)}}}),f.fn.extend({on:function(a,c,d,e,g){var +h,i;if(typeof a==“object”){typeof c!=“string”&&(d=c,c=b);for(i in +a)this.on(i,c,d,a,g);return +this}d==null&&e==null?(e=c,d=c=b):e==null&&(typeof +c==“string”?(e=d,d=b):(e=d,d=c,c=b));if(e===!1)e=J;else if(!e)return +this;g===1&&(h=e,e=function(a){f().off(a);return +h.apply(this,arguments)},e.guid=h.guid||(h.guid=f.guid++));return +this.each(function(){f.event.add(this,a,e,d,c)})},one:function(a,b,c,d){return +this.on.call(this,a,b,c,d,1)},off:function(a,c,d){if(a&&a.preventDefault&&a.handleObj){var +e=a.handleObj;f(a.delegateTarget).off(e.namespace?e.type+“.”+e.namespace:e.type,e.selector,e.handler);return +this}if(typeof a==“object”){for(var g in a)this.off(g,c,a);return this}if(c===!1||typeof +c==“function”)d=c,c=b;d===!1&&(d=J);return +this.each(function(){f.event.remove(this,a,d,c)})},bind:function(a,b,c){return +this.on(a,null,b,c)},unbind:function(a,b){return +this.off(a,null,b)},live:function(a,b,c){f(this.context).on(a,this.selector,b,c);return +this},die:function(a,b){f(this.context).off(a,this.selector||“**”,b);return +this},delegate:function(a,b,c,d){return +this.on(b,a,c,d)},undelegate:function(a,b,c){return +arguments.length==1?this.off(a,“**”):this.off(b,a,c)},trigger:function(a,b){return +this.each(function(){f.event.trigger(a,b,this)})},triggerHandler:function(a,b){if(this)return f.event.trigger(a,b,this,!0)},toggle:function(a){var +b=arguments,c=a.guid||f.guid++,d=0,e=function©{var +e=(f._data(this,“lastToggle”+a.guid)||0)%d;f._data(this,“lastToggle”+a.guid,e+1),c.preventDefault();return +b.apply(this,arguments)||!1};e.guid=c;while(d.guid=c;return +this.click(e)},hover:function(a,b){return +this.mouseenter(a).mouseleave(b||a)}}),f.each(“blur focus focusin focusout +load resize scroll unload click dblclick mousedown mouseup mousemove +mouseover mouseout mouseenter mouseleave change select submit keydown +keypress keyup error contextmenu”.split(“ ”),function(a,b){f.fn=function(a,c){c==null&&(c=a,a=null);return +arguments.length>0?this.on(b,null,a,c):this.trigger(b)},f.attrFn&&(f.attrFn=!0),C.test(b)&&(f.event.fixHooks=f.event.keyHooks),D.test(b)&&(f.event.fixHooks=f.event.mouseHooks)}),function(){function +x(a,b,c,e,f,g){for(var h=0,i=e.length;h<i;h++){var j=e;if(j){var k=!1;j=j;while(j){if(j===c){k=e;break}if(j.nodeType===1){g||(j=c,j.sizset=h);if(typeof +b!=“string”){if(j===b){k=!0;break}}else if(m.filter(b,).length>0){k=j;break}}j=j}e=k}}}function w(a,b,c,e,f,g){for(var +h=0,i=e.length;h<i;h++){var j=e;if(j){var k=!1;j=j;while(j){if(j===c){k=e;break}j.nodeType===1&&!g&&(j=c,j.sizset=h);if(j.nodeName.toLowerCase()===b){k=j;break}j=j}e=k}}}var a=/((?:((?:(+)|[^()]+)+)|[(?:[[^[]]*]|['“][^'”]*['“]|[^[]'”]+)+]|\.|[^ +>+~,([\]+)+|[>+~])(s*,s*)?((?:.|r|n)*)/g,d=“sizcache”+(Math.random()+“”).replace(“.”,“”),e=0,g=Object.prototype.toString,h=!1,i=!0,j=/\/g,k=/rn/g,l=/W/;.sort(function(){i=!1;return +0});var m=function(b,d,e,f){e=e||[],d=d||c;var +h=d;if(d.nodeType!==1&&d.nodeType!==9)return[];if(!b||typeof +b!=“string”)return e;var i,j,k,l,n,q,r,t,u=!0,v=m.isXML(d),w=[],x=b;do{a.exec(“”),i=a.exec(x);if(i){x=i,w.push(i);if(i){l=i;break}}}while(i);if(w.length>1&&p.exec(b))if(w.length===2&&o.relative[w])j=y(w+w,d,f);else{j=o.relative[w]?[d]:m(w.shift(),d);while(w.length)b=w.shift(),o.relative&&(b+=w.shift()),j=y(b,j,f)}else{!f&&w.length>1&&d.nodeType===9&&!v&&o.match.ID.test(w)&&!o.match.ID.test(w)&&(n=m.find(w.shift(),d,v),d=n.expr?m.filter(n.expr,n.set):n.set);if(d){n=f?{expr:w.pop(),set:s(f)}:m.find(w.pop(),w.length===1&&(w===“~”||w===“+”)&&d.parentNode?d.parentNode:d,v),j=n.expr?m.filter(n.expr,n.set):n.set,w.length>0?k=s(j):u=!1;while(w.length)q=w.pop(),r=q,o.relative?r=w.pop():q=“”,r==null&&(r=d),o.relative(k,r,v)}else +k=w=[]}k||(k=j),k||m.error(q||b);if(g.call(k)===“[object +Array]”)if(!u)e.push.apply(e,k);else if(d&&d.nodeType===1)for(t=0;k!=null;t++)k&&(k===!0||k.nodeType===1&&m.contains(d,k))&&e.push(j);else for(t=0;k!=null;t++)k&&k.nodeType===1&&e.push(j);else +s(k,e);l&&(m(l,h,e,f),m.uniqueSort(e));return +e};m.uniqueSort=function(a){if(u){h=i,a.sort(u);if(h)for(var b=1;b===a&&a.splice(b–,1)}return +a},m.matches=function(a,b){return +m(a,null,null,b)},m.matchesSelector=function(a,b){return m(b,null,null,).length>0},m.find=function(a,b,c){var d,e,f,g,h,i;if(!a)return[];for(e=0,f=o.order.length;e;if(g=o.leftMatch.exec(a)){i=g,g.splice(1,1);if(i.substr(i.length-1)!==“\”){g=(g||“”).replace(j,“”),d=o.find(g,b,c);if(d!=null){a=a.replace(o.match,“”);break}}}}d||(d=typeof +b.getElementsByTagName!=“undefined”?b.getElementsByTagName(“*”):[]);return{set:d,expr:a}},m.filter=function(a,c,d,e){var +f,g,h,i,j,k,l,n,p,q=a,r=[],s=c,t=c&&c&&m.isXML(c);while(a&&c.length){for(h in o.filter)if((f=o.leftMatch.exec(a))!=null&&f){k=o.filter,l=f,g=!1,f.splice(1,1);if(l.substr(l.length-1)===“\”)continue;s===r&&(r=[]);if(o.preFilter){f=o.preFilter(f,s,d,r,e,t);if(!f)g=i=!0;else +if(f===!0)continue}if(f)for(n=0;(j=s)!=null;n++)j&&(i=k(j,f,n,s),p=e^i,d&&i!=null?p?g=!0:s=!1:p&&(r.push(j),g=!0));if(i!==b){d||(s=r),a=a.replace(o.match,“”);if(!g)return[];break}}if(a===q)if(g==null)m.error(a);else +break;q=a}return s},m.error=function(a){throw new Error(“Syntax error, +unrecognized expression: ”+a)};var n=m.getText=function(a){var +b,c,d=a.nodeType,e=“”;if(d){if(d===1||d===9){if(typeof +a.textContent==“string”)return a.textContent;if(typeof +a.innerText==“string”)return +a.innerText.replace(k,“”);for(a=a.firstChild;a;a=a.nextSibling)e+=n(a)}else +if(d===3||d===4)return a.nodeValue}else for(b=0;c=a;b++)c.nodeType!==8&&(e+=n©);return +e},o=m.selectors={order:,match:{ID:/#((?:|\.)+)/,CLASS:/.((?:|\.)+)/,NAME:/[name=*((?:[wu00c0-uFFFF-]|\.)+)*]/,ATTR:/[s*((?:|\.)+)s*(?:(S?=)s*(?:()(.*?)3|(#?(?:|\.)*)|)|)s*]/,TAG:/^((?:|\.)+)/,CHILD:/:(only|nth|last|first)-child(?:(s*(even|odd|(?:?d+|(?:?d*)?ns*(?:s*d+)?))s*))?/,POS:/:(nth|eq|gt|lt|first|last|even|odd)(?:((d*)))?(?=|$)/,PSEUDO:/:((?:|\.)+)(?:((['“]?)((?:([^)]+)|[^()]*)+)2))?/},leftMatch:{},attrMap:{”class“:”className“,”for“:”htmlFor“},attrHandle:{href:function(a){return +a.getAttribute(”href“)},type:function(a){return +a.getAttribute(”type“)}},relative:{”+“:function(a,b){var c=typeof +b==”string“,d=c&&!l.test(b),e=c&&!d;d&&(b=b.toLowerCase());for(var +f=0,g=a.length,h;f){while((h=h.previousSibling)&&h.nodeType!==1);a=e||h&&h.nodeName.toLowerCase()===b?h||!1:h===b}e&&m.filter(b,a,!0)},”>“:function(a,b){var +c,d=typeof +b==”string“,e=0,f=a.length;if(d&&!l.test(b)){b=b.toLowerCase();for(;e<f;e++){c=a;if©{var g=c.parentNode;a=g.nodeName.toLowerCase()===b?g:!1}}}else{for(;e,c&&(a=d?c.parentNode:c.parentNode===b);d&&m.filter(b,a,!0)}},”“:function(a,b,c){var +d,f=e++,g=x;typeof +b==”string“&&!l.test(b)&&(b=b.toLowerCase(),d=b,g=w),g(”parentNode“,b,f,a,d,c)},”~“:function(a,b,c){var +d,f=e++,g=x;typeof +b==”string“&&!l.test(b)&&(b=b.toLowerCase(),d=b,g=w),g(”previousSibling“,b,f,a,d,c)}},find:{ID:function(a,b,c){if(typeof +b.getElementById!=”undefined“&&!c){var d=b.getElementById(a);return d&&d.parentNode?:[]}},NAME:function(a,b){if(typeof +b.getElementsByName!=”undefined“){var c=[],d=b.getElementsByName(a);for(var e=0,f=d.length;e.getAttribute(”name“)===a&&c.push(d);return +c.length===0?null:c}},TAG:function(a,b){if(typeof +b.getElementsByTagName!=”undefined“)return b.getElementsByTagName(a)}},preFilter:{CLASS:function(a,b,c,d,e,f){a=” +“+a.replace(j,”“)+” “;if(f)return a;for(var g=0,h;(h=b)!=null;g++)h&&(e^(h.className&&(” +“h.className” “).replace(//g,” “).indexOf(a)>=0)?c||d.push(h):c&&(b=!1));return!1},ID:function(a){return +a.replace(j,”“)},TAG:function(a,b){return a.replace(j,”“).toLowerCase()},CHILD:function(a){if(a===”nth“){a||m.error(a),a=a.replace(/^+|s*/g,”“);var b=/(-?)(d*)(?:n(?d*))?/.exec(a===”even“&&”2n“||a===”odd“&&”2n+1“||!/D/.test(a)&&”0n+“+a||a);a=b+(b||1)-0,a=b-0}else a&&m.error(a);a=e++;return +a},ATTR:function(a,b,c,d,e,f){var g=a=a.replace(j,”“);!f&&o.attrMap&&(a=o.attrMap),a=(a||a||”“).replace(j,”“),a===”~=“&&(a=” “+a+” “);return +a},PSEUDO:function(b,c,d,e,f){if(b===”not“)if((a.exec(b)||”“).length>1||/^w/.test(b))b=m(b,null,null,c);else{var g=m.filter(b,c,d,!0^f);d||e.push.apply(e,g);return!1}else if(o.match.POS.test(b)||o.match.CHILD.test(b))return!0;return +b},POS:function(a){a.unshift(!0);return +a}},filters:{enabled:function(a){return +a.disabled===!1&&a.type!==”hidden“},disabled:function(a){return +a.disabled===!0},checked:function(a){return +a.checked===!0},selected:function(a){a.parentNode&&a.parentNode.selectedIndex;return +a.selected===!0},parent:function(a){return!!a.firstChild},empty:function(a){return!a.firstChild},has:function(a,b,c){return!!m(c,a).length},header:function(a){return/hd/i.test(a.nodeName)},text:function(a){var +b=a.getAttribute(”type“),c=a.type;return +a.nodeName.toLowerCase()===”input“&&”text“===c&&(b===c||b===null)},radio:function(a){return +a.nodeName.toLowerCase()===”input“&&”radio“===a.type},checkbox:function(a){return +a.nodeName.toLowerCase()===”input“&&”checkbox“===a.type},file:function(a){return +a.nodeName.toLowerCase()===”input“&&”file“===a.type},password:function(a){return +a.nodeName.toLowerCase()===”input“&&”password“===a.type},submit:function(a){var +b=a.nodeName.toLowerCase();return(b===”input“||b===”button“)&&”submit“===a.type},image:function(a){return +a.nodeName.toLowerCase()===”input“&&”image“===a.type},reset:function(a){var +b=a.nodeName.toLowerCase();return(b===”input“||b===”button“)&&”reset“===a.type},button:function(a){var +b=a.nodeName.toLowerCase();return +b===”input“&&”button“===a.type||b===”button“},input:function(a){return/input|select|textarea|button/i.test(a.nodeName)},focus:function(a){return +a===a.ownerDocument.activeElement}},setFilters:{first:function(a,b){return +b===0},last:function(a,b,c,d){return +b===d.length-1},even:function(a,b){return b%2===0},odd:function(a,b){return +b%2===1},lt:function(a,b,c){return b-0},gt:function(a,b,c){return b>c-0},nth:function(a,b,c){return c-0===b},eq:function(a,b,c){return c-0===b}},filter:{PSEUDO:function(a,b,c,d){var e=b,f=o.filters;if(f)return f(a,c,b,d);if(e===”contains“)return(a.textContent||a.innerText||n()||”“).indexOf(b)>=0;if(e===”not“){var g=b;for(var +h=0,i=g.length;h===a)return!1;return!0}m.error(e)},CHILD:function(a,b){var +c,e,f,g,h,i,j,k=b,l=a;switch(k){case”only“:case”first“:while(l=l.previousSibling)if(l.nodeType===1)return!1;if(k===”first“)return!0;l=a;case”last“:while(l=l.nextSibling)if(l.nodeType===1)return!1;return!0;case”nth“:c=b,e=b;if(c===1&&e===0)return!0;f=b,g=a.parentNode;if(g&&(g!==f||!a.nodeIndex)){i=0;for(l=g.firstChild;l;l=l.nextSibling)l.nodeType===1&&(l.nodeIndex=++i);g=f}j=a.nodeIndex-e;return +c===0?j===0:j%c===0&&j/c>=0}},ID:function(a,b){return +a.nodeType===1&&a.getAttribute(”id“)===b},TAG:function(a,b){return +b===”*“&&a.nodeType===1||!!a.nodeName&&a.nodeName.toLowerCase()===b},CLASS:function(a,b){return(” +“+(a.className||a.getAttribute(”class“))+” +“).indexOf(b)>-1},ATTR:function(a,b){var c=b,d=m.attr?m.attr(a,c):o.attrHandle?o.attrHandle(a):a!=null?a:a.getAttribute©,e=d+”“,f=b,g=b;return +d==null?f===”!=“:!f&&m.attr?d!=null:f===”=“?e===g:f===”*=“?e.indexOf(g)>=0:f===”~=“?(” +“e” +“).indexOf(g)>=0:g?f===”!=“?e!==g:f===”^=“?e.indexOf(g)===0:f===”$=“?e.substr(e.length-g.length)===g:f===”|=“?e===g||e.substr(0,g.length+1)===g+”-“:!1:e&&d!==!1},POS:function(a,b,c,d){var +e=b,f=o.setFilters;if(f)return +f(a,c,b,d)}}},p=o.match.POS,q=function(a,b){return”\“+(b-0+1)};for(var r in +o.match)o.match=new RegExp(o.match.source+/(?![^*])(?![^(]*))/.source),o.leftMatch=new RegExp(/(^(?:.|r|n)*?)/.source+o.match.source.replace(/\(d+)/g,q));var +s=function(a,b){a=Array.prototype.slice.call(a,0);if(b){b.push.apply(b,a);return +b}return a};try{Array.prototype.slice.call(c.documentElement.childNodes,0).nodeType}catch(t){s=function(a,b){var +c=0,d=b||[];if(g.call(a)===”[object +Array]“)Array.prototype.push.apply(d,a);else if(typeof +a.length==”number“)for(var e=a.length;c);else for(;a;c++)d.push(a);return d}}var +u,v;c.documentElement.compareDocumentPosition?u=function(a,b){if(a===b){h=!0;return +0}if(!a.compareDocumentPosition||!b.compareDocumentPosition)return +a.compareDocumentPosition?-1:1;return +a.compareDocumentPosition(b)&4?-1:1}:(u=function(a,b){if(a===b){h=!0;return +0}if(a.sourceIndex&&b.sourceIndex)return +a.sourceIndex-b.sourceIndex;var c,d,e=[],f=,g=a.parentNode,i=b.parentNode,j=g;if(g===i)return +v(a,b);if(!g)return-1;if(!i)return +1;while(j)e.unshift(j),j=j.parentNode;j=i;while(j)f.unshift(j),j=j.parentNode;c=e.length,d=f.length;for(var +k=0;k!==f)return v(e,f);return k===c?v(a,f,-1):v(e,b,1)},v=function(a,b,c){if(a===b)return c;var +d=a.nextSibling;while(d){if(d===b)return-1;d=d.nextSibling}return +1}),function(){var a=c.createElement(”div“),d=”script“+(new +Date).getTime(),e=c.documentElement;a.innerHTML=”<a +name='“d”'/>“,e.insertBefore(a,e.firstChild),c.getElementById(d)&&(o.find.ID=function(a,c,d){if(typeof +c.getElementById!=”undefined“&&!d){var e=c.getElementById(a);return e?e.id===a||typeof e.getAttributeNode!=”undefined“&&e.getAttributeNode(”id“).nodeValue===a?[e]:b:[]}},o.filter.ID=function(a,b){var +c=typeof +a.getAttributeNode!=”undefined“&&a.getAttributeNode(”id“);return +a.nodeType===1&&c&&c.nodeValue===b}),e.removeChild(a),e=a=null}(),function(){var +a=c.createElement(”div“);a.appendChild(c.createComment(”“)),a.getElementsByTagName(”*“).length>0&&(o.find.TAG=function(a,b){var +c=b.getElementsByTagName(a);if(a===”*“){var +d=[];for(var e=0;c;e++)c.nodeType===1&&d.push(c);c=d}return c}),a.innerHTML=”<a +href='#'></a>“,a.firstChild&&typeof +a.firstChild.getAttribute!=”undefined“&&a.firstChild.getAttribute(”href“)!==”#“&&(o.attrHandle.href=function(a){return +a.getAttribute(”href“,2)}),a=null}(),c.querySelectorAll&&function(){var +a=m,b=c.createElement(”div“),d=”__sizzle__“;b.innerHTML=”<p +class='TEST'></p>“;if(!b.querySelectorAll||b.querySelectorAll(”.TEST“).length!==0){m=function(b,e,f,g){e=e||c;if(!g&&!m.isXML(e)){var +h=/^(w+$)|^.(+$)|^#([w-]+$)/.exec(b);if(h&&(e.nodeType===1||e.nodeType===9)){if(h)return s(e.getElementsByTagName(b),f);if(h&&o.find.CLASS&&e.getElementsByClassName)return +s(e.getElementsByClassName(h),f)}if(e.nodeType===9){if(b===”body“&&e.body)return +s(,f);if(h&&h){var i=e.getElementById(h);if(!i||!i.parentNode)return s([],f);if(i.id===h)return s(,f)}try{return +s(e.querySelectorAll(b),f)}catch(j){}}else +if(e.nodeType===1&&e.nodeName.toLowerCase()!==”object“){var k=e,l=e.getAttribute(”id“),n=l||d,p=e.parentNode,q=/^s*/.test(b);l?n=n.replace(/'/g,”\$&“):e.setAttribute(”id“,n),q&&p&&(e=e.parentNode);try{if(!q||p)return +s(e.querySelectorAll(” +“+b),f)}catch®{}finally{l||k.removeAttribute(”id“)}}}return +a(b,e,f,g)};for(var e in a)m=a;b=null}}(),function(){var +a=c.documentElement,b=a.matchesSelector||a.mozMatchesSelector||a.webkitMatchesSelector||a.msMatchesSelector;if(b){var +d=!b.call(c.createElement(”div“),”div“),e=!1;try{b.call(c.documentElement,”:sizzle“)}catch(f){e=!0}m.matchesSelector=function(a,c){c=c.replace(/=s*(]*)s*]/g,”='$1']“);if(!m.isXML(a))try{if(e||!o.match.PSEUDO.test©&&!/!=/.test©){var +f=b.call(a,c);if(f||!d||a.document&&a.document.nodeType!==11)return +f}}catch(g){}return m(c,null,null,).length>0}}}(),function(){var +a=c.createElement(”div“);a.innerHTML=”<div class='test +e'></div><div +class='test'></div>“;if(!!a.getElementsByClassName&&a.getElementsByClassName(”e“).length!==0){a.lastChild.className=”e“;if(a.getElementsByClassName(”e“).length===1)return;o.order.splice(1,0,”CLASS“),o.find.CLASS=function(a,b,c){if(typeof +b.getElementsByClassName!=”undefined“&&!c)return b.getElementsByClassName(a)},a=null}}(),c.documentElement.contains?m.contains=function(a,b){return +a!==b&&(a.contains?a.contains(b):!0)}:c.documentElement.compareDocumentPosition?m.contains=function(a,b){return!!(a.compareDocumentPosition(b)&16)}:m.contains=function(){return!1},m.isXML=function(a){var +b=(a?a.ownerDocument||a:0).documentElement;return +b?b.nodeName!==”HTML“:!1};var y=function(a,b,c){var d,e=[],f=”“,g=b.nodeType?:b;while(d=o.match.PSEUDO.exec(a))f+=d,a=a.replace(o.match.PSEUDO,”“);a=o.relative?a+”*“:a;for(var h=0,i=g.length;h,e,c);return +m.filter(f,e)};m.attr=f.attr,m.selectors.attrMap={},f.find=m,f.expr=m.selectors,f.expr=f.expr.filters,f.unique=m.uniqueSort,f.text=m.getText,f.isXMLDoc=m.isXML,f.contains=m.contains}();var +L=/Until$/,M=/^(?:parents|prevUntil|prevAll)/,N=/,/,O=/^.[^:#*$/,P=Array.prototype.slice,Q=f.expr.match.POS,R={children:!0,contents:!0,next:!0,prev:!0};f.fn.extend({find:function(a){var +b=this,c,d;if(typeof a!=”string“)return f(a).filter(function(){for(c=0,d=b.length;c,this))return!0});var +e=this.pushStack(”“,”find“,a),g,h,i;for(c=0,d=this.length;c<d;c++){g=e.length,f.find(a,this,e);if(c>0)for(h=g;h===e){e.splice(h–,1);break}}return e},has:function(a){var +b=f(a);return this.filter(function(){for(var a=0,c=b.length;a))return!0})},not:function(a){return +this.pushStack(T(this,a,!1),”not“,a)},filter:function(a){return +this.pushStack(T(this,a,!0),”filter“,a)},is:function(a){return!!a&&(typeof +a==”string“?Q.test(a)?f(a,this.context).index(this)>=0:f.filter(a,this).length>0:this.filter(a).length>0)},closest:function(a,b){var +c=[],d,e,g=this;if(f.isArray(a)){var +h=1;while(g&&g.ownerDocument&&g!==b){for(d=0;d)&&c.push({selector:a,elem:g,level:h});g=g.parentNode,h++}return c}var +i=Q.test(a)||typeof +a!=”string“?f(a,b||this.context):0;for(d=0,e=this.length;d<e;d++){g=this;while(g){if(i?i.index(g)>-1:f.find.matchesSelector(g,a)){c.push(g);break}g=g.parentNode;if(!g||!g.ownerDocument||g===b||g.nodeType===11)break}}c=c.length>1?f.unique©:c;return +this.pushStack(c,”closest“,a)},index:function(a){if(!a)return this&&this.parentNode?this.prevAll().length:-1;if(typeof +a==”string“)return f.inArray(this,f(a));return f.inArray(a.jquery?a:a,this)},add:function(a,b){var c=typeof +a==”string“?f(a,b):f.makeArray(a&&a.nodeType?:a),d=f.merge(this.get(),c);return +this.pushStack(S(c)||S(d)?d:f.unique(d))},andSelf:function(){return +this.add(this.prevObject)}}),f.each({parent:function(a){var +b=a.parentNode;return +b&&b.nodeType!==11?b:null},parents:function(a){return +f.dir(a,”parentNode“)},parentsUntil:function(a,b,c){return +f.dir(a,”parentNode“,c)},next:function(a){return +f.nth(a,2,”nextSibling“)},prev:function(a){return +f.nth(a,2,”previousSibling“)},nextAll:function(a){return +f.dir(a,”nextSibling“)},prevAll:function(a){return +f.dir(a,”previousSibling“)},nextUntil:function(a,b,c){return +f.dir(a,”nextSibling“,c)},prevUntil:function(a,b,c){return +f.dir(a,”previousSibling“,c)},siblings:function(a){return +f.sibling(a.parentNode.firstChild,a)},children:function(a){return +f.sibling(a.firstChild)},contents:function(a){return +f.nodeName(a,”iframe“)?a.contentDocument||a.contentWindow.document:f.makeArray(a.childNodes)}},function(a,b){f.fn=function(c,d){var +e=f.map(this,b,c);L.test(a)||(d=c),d&&typeof d==”string“&&(e=f.filter(d,e)),e=this.length>1&&!R?f.unique(e):e,(this.length>1||N.test(d))&&M.test(a)&&(e=e.reverse());return +this.pushStack(e,a,P.call(arguments).join(”,“))}}),f.extend({filter:function(a,b,c){c&&(a=”:not(“a”)“);return +b.length===1?f.find.matchesSelector(b,a)?[b]:[]:f.find.matches(a,b)},dir:function(a,c,d){var e=[],g=a;while(g&&g.nodeType!==9&&(d===b||g.nodeType!==1||!f(g).is(d)))g.nodeType===1&&e.push(g),g=g;return +e},nth:function(a,b,c,d){b=b||1;var e=0;for(;a;a=a)if(a.nodeType===1&&++e===b)break;return +a},sibling:function(a,b){var +c=[];for(;a;a=a.nextSibling)a.nodeType===1&&a!==b&&c.push(a);return +c}});var +V=”abbr|article|aside|audio|canvas|datalist|details|figcaption|figure|footer|header|hgroup|mark|meter|nav|output|progress|section|summary|time|video“,W=/ +jQueryd+=”(?:d+|null)“/g,X=/^s+/,Y=/<(?!area|br|col|embed|hr|img|input|link|meta|param)((+)[^>]*)/>/ig,Z=/<(+)/,$=/<tbody/i,_=/<|&#?w+;/,ba=/<(?:script|style)/i,bb=/<(?:script|object|embed|option|style)/i,bc=new +RegExp(”<(?:"V")","i"),bd=/checked\s*(?:|=s*.checked.)/i,be=//(java|ecma)script/i,bf=/^s*<!(?:[CDATA[|--)/,bg={option:[1,“<select +”,“”“>multiple=‘multiple’>”,“”],legend:,“,”“”>thead:,“,”“”>tr:,“,”“”>td:,“,”“”>col:,“,”“”>area:,_default:},“,”“”>bh=U©;bg.optgroup=bg.option,bg.tbody=bg.tfoot=bg.colgroup=bg.caption=bg.thead,bg.th=bg.td,f.support.htmlSerialize||(bg._default=),f.fn.extend({text:function(a){if(f.isFunction(a))return +this.each(function(b){var +c=f(this);c.text(a.call(this,b,c.text()))});if(typeof +a!=“object”&&a!==b)return this.empty().append((this&&this.ownerDocument||c).createTextNode(a));return +f.text(this)},wrapAll:function(a){if(f.isFunction(a))return +this.each(function(b){f(this).wrapAll(a.call(this,b))});if(this){var b=f(a,this.ownerDocument).eq(0).clone(!0);this.parentNode&&b.insertBefore(this),b.map(function(){var +a=this;while(a.firstChild&&a.firstChild.nodeType===1)a=a.firstChild;return +a}).append(this)}return +this},wrapInner:function(a){if(f.isFunction(a))return +this.each(function(b){f(this).wrapInner(a.call(this,b))});return +this.each(function(){var +b=f(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){var +b=f.isFunction(a);return +this.each(function©{f(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(){return +this.parent().each(function(){f.nodeName(this,“body”)||f(this).replaceWith(this.childNodes)}).end()},append:function(){return +this.domManip(arguments,!0,function(a){this.nodeType===1&&this.appendChild(a)})},prepend:function(){return +this.domManip(arguments,!0,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this&&this.parentNode)return +this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this)});if(arguments.length){var +a=f.clean(arguments);a.push.apply(a,this.toArray());return +this.pushStack(a,“before”,arguments)}},after:function(){if(this&&this.parentNode)return +this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this.nextSibling)});if(arguments.length){var +a=this.pushStack(this,“after”,arguments);a.push.apply(a,f.clean(arguments));return +a}},remove:function(a,b){for(var c=0,d;(d=this)!=null;c++)if(!a||f.filter(a,).length)!b&&d.nodeType===1&&(f.cleanData(d.getElementsByTagName(“*”)),f.cleanData()),d.parentNode&&d.parentNode.removeChild(d);return +this},empty:function() {for(var a=0,b;(b=this)!=null;a++){b.nodeType===1&&f.cleanData(b.getElementsByTagName(“*”));while(b.firstChild)b.removeChild(b.firstChild)}return +this},clone:function(a,b){a=a==null?!1:a,b=b==null?a:b;return +this.map(function(){return +f.clone(this,a,b)})},html:function(a){if(a===b)return this&&this.nodeType===1?this.innerHTML.replace(W,“”):null;if(typeof a==“string”&&!ba.test(a)&&(f.support.leadingWhitespace||!X.test(a))&&!bg[(Z.exec(a)||)[1].toLowerCase()]){a=a.replace(Y,“<$1></$2>”);try{for(var +c=0,d=this.length;c.nodeType===1&&(f.cleanData(this.getElementsByTagName(“*”)),this.innerHTML=a)}catch(e){this.empty().append(a)}}else +f.isFunction(a)?this.each(function(b){var +c=f(this);c.html(a.call(this,b,c.html()))}):this.empty().append(a);return +this},replaceWith:function(a){if(this&&this.parentNode){if(f.isFunction(a))return +this.each(function(b){var +c=f(this),d=c.html();c.replaceWith(a.call(this,b,d))});typeof +a!=“string”&&(a=f(a).detach());return this.each(function(){var +b=this.nextSibling,c=this.parentNode;f(this).remove(),b?f(b).before(a):f©.append(a)})}return +this.length?this.pushStack(f(f.isFunction(a)?a():a),“replaceWith”,a):this},detach:function(a){return +this.remove(a,!0)},domManip:function(a,c,d){var e,g,h,i,j=a,k=[];if(!f.support.checkClone&&arguments.length===3&&typeof +j==“string”&&bd.test(j))return +this.each(function(){f(this).domManip(a,c,d,!0)});if(f.isFunction(j))return +this.each(function(e){var g=f(this);a=j.call(this,e,c?g.html():b),g.domManip(a,c,d)});if(this){i=j&&j.parentNode,f.support.parentNode&&i&&i.nodeType===11&&i.childNodes.length===this.length?e={fragment:i}:e=f.buildFragment(a,this,k),h=e.fragment,h.childNodes.length===1?g=h=h.firstChild:g=h.firstChild;if(g){c=c&&f.nodeName(g,“tr”);for(var +l=0,m=this.length,n=m-1;l,g):this,e.cacheable||m>1&&l<n?f.clone(h,!0,!0):h)}k.length&&f.each(k,bp)}return +this}}),f.buildFragment=function(a,b,d){var e,g,h,i,j=a;b&&b&&(i=b.ownerDocument||b),i.createDocumentFragment||(i=c),a.length===1&&typeof +j==“string”&&j.length<512&&i===c&&j.charAt(0)==="<"&&!bb.test(j)&&(f.support.checkClone||!bd.test(j))&&(f.support.html5Clone||!bc.test(j))&&(g=!0,h=f.fragments,h&&h!==1&&(e=h)),e||(e=i.createDocumentFragment(),f.clean(a,i,e,d)),g&&(f.fragments=h?e:1);return{fragment:e,cacheable:g}},f.fragments={},f.each({appendTo:“append”,prependTo:“prepend”,insertBefore:“before”,insertAfter:“after”,replaceAll:“replaceWith”},function(a,b){f.fn=function©{var d=[],e=f©,g=this.length===1&&this.parentNode;if(g&&g.nodeType===11&&g.childNodes.length===1&&e.length===1){e(this);return this}for(var +h=0,i=e.length;h<i;h++){var j=(h>0?this.clone(!0):this).get();f(e)[b](j),d=d.concat(j)}return +this.pushStack(d,a,e.selector)}}),f.extend({clone:function(a,b,c){var +d,e,g,h=f.support.html5Clone||!bc.test(“<”+a.nodeName)?a.cloneNode(!0):bo(a);if((!f.support.noCloneEvent||!f.support.noCloneChecked)&&(a.nodeType===1||a.nodeType===11)&&!f.isXMLDoc(a)){bk(a,h),d=bl(a),e=bl(h);for(g=0;d;++g)e&&bk(d,e)}if(b){bj(a,h);if©{d=bl(a),e=bl(h);for(g=0;d;++g)bj(d,e)}}d=e=null;return h},clean:function(a,b,d,e){var +g;b=b||c,typeof b.createElement==“undefined”&&(b=b.ownerDocument||b&&b.ownerDocument||c);var h=[],i;for(var j=0,k;(k=a)!=null;j++){typeof +k==“number”&&(k+=“”);if(!k)continue;if(typeof +k==“string”)if(!_.test(k))k=b.createTextNode(k);else{k=k.replace(Y,“<$1></$2>”);var +l=(Z.exec(k)||)[1].toLowerCase(),m=bg||bg._default,n=m,o=b.createElement(“div”);b===c?bh.appendChild(o):U(b).appendChild(o),o.innerHTML=m+k+m;while(n–)o=o.lastChild;if(!f.support.tbody){var p=$.test(k),q=l===“table”&&!p?o.firstChild&&o.firstChild.childNodes:m===“<table>”&&!p?o.childNodes:[];for(i=q.length-1;i>=0;–i)f.nodeName(q,“tbody”)&&!q.childNodes.length&&q.parentNode.removeChild(q)}!f.support.leadingWhitespace&&X.test(k)&&o.insertBefore(b.createTextNode(X.exec(k)),o.firstChild),k=o.childNodes}var +r;if(!f.support.appendChecked)if(k&&typeof (r=k.length)==“number”)for(i=0;i);else +bn(k);k.nodeType?h.push(k):h=f.merge(h,k)}if(d){g=function(a){return!a.type||be.test(a.type)};for(j=0;h;j++)if(e&&f.nodeName(h,“script”)&&(!h.type||h.type.toLowerCase()===“text/javascript”))e.push(h.parentNode?h.parentNode.removeChild(h):h);else{if(h.nodeType===1){var s=f.grep(h.getElementsByTagName(“script”),g);h.splice.apply(h,.concat(s))}d.appendChild(h)}}return h},cleanData:function(a){var +b,c,d=f.cache,e=f.event.special,g=f.support.deleteExpando;for(var h=0,i;(i=a)!=null;h++){if(i.nodeName&&f.noData)continue;c=i;if©{b=d;if(b&&b.events){for(var j in b.events)e?f.event.remove(i,j):f.removeEvent(i,j,b.handle);b.handle&&(b.handle.elem=null)}g?delete +i:i.removeAttribute&&i.removeAttribute(f.expando),delete +d}}}});var bq=/alpha(*)/i,br=/opacity=(*)/,bs=/(|^ms)/g,bt=/^-?d+(?:px)?$/i,bu=/^-?d/,bv=/^()=([-+.de]+)/,bw={position:“absolute”,visibility:“hidden”,display:“block”},bx=,by=,bz,bA,bB;f.fn.css=function(a,c){if(arguments.length===2&&c===b)return +this;return f.access(this,a,c,!0,function(a,c,d){return +d!==b?f.style(a,c,d):f.css(a,c)})},f.extend({cssHooks:{opacity:{get:function(a,b){if(b){var +c=bz(a,“opacity”,“opacity”);return c===“”?“1”:c}return +a.style.opacity}}},cssNumber:{fillOpacity:!0,fontWeight:!0,lineHeight:!0,opacity:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{“float”:f.support.cssFloat?“cssFloat”:“styleFloat”},style:function(a,c,d,e){if(!!a&&a.nodeType!==3&&a.nodeType!==8&&!!a.style){var +g,h,i=f.camelCase©,j=a.style,k=f.cssHooks;c=f.cssProps||i;if(d===b){if(k&&“get”in +k&&(g=k.get(a,!1,e))!==b)return g;return j}h=typeof +d,h===“string”&&(g=bv.exec(d))&&(d=+(g+1)*+g+parseFloat(f.css(a,c)),h=“number”);if(d==null||h===“number”&&isNaN(d))return;h===“number”&&!f.cssNumber&&(d+=“px”);if(!k||!(“set”in +k)||(d=k.set(a,d))!==b)try{j=d}catch(l){}}},css:function(a,c,d){var e,g;c=f.camelCase©,g=f.cssHooks,c=f.cssProps||c,c===“cssFloat”&&(c=“float”);if(g&&“get”in +g&&(e=g.get(a,!0,d))!==b)return e;if(bz)return +bz(a,c)},swap:function(a,b,c){var d={};for(var e in b)d=a.style,a.style=b;c.call(a);for(e in b)a.style=d}}),f.curCSS=f.css,f.each(,function(a,b){f.cssHooks={get:function(a,c,d){var +e;if©{if(a.offsetWidth!==0)return +bC(a,b,d);f.swap(a,bw,function(){e=bC(a,b,d)});return +e}},set:function(a,b){if(!bt.test(b))return +b;b=parseFloat(b);if(b>=0)return +b+“px”}}}),f.support.opacity||(f.cssHooks.opacity={get:function(a,b){return +br.test((b&&a.currentStyle?a.currentStyle.filter:a.style.filter)||“”)?parseFloat(RegExp.$1)/100+“”:b?“1”:“”},set:function(a,b){var +c=a.style,d=a.currentStyle,e=f.isNumeric(b)?“alpha(opacity=”+b*100+“)”:“”,g=d&&d.filter||c.filter||“”;c.zoom=1;if(b>=1&&f.trim(g.replace(bq,“”))===“”){c.removeAttribute(“filter”);if(d&&!d.filter)return}c.filter=bq.test(g)?g.replace(bq,e):g+“ +”+e}}),f(function(){f.support.reliableMarginRight||(f.cssHooks.marginRight={get:function(a,b){var +c;f.swap(a,{display:“inline-block”},function(){b?c=bz(a,“margin-right”,“marginRight”):c=a.style.marginRight});return +c}})}),c.defaultView&&c.defaultView.getComputedStyle&&(bA=function(a,b){var +c,d,e;b=b.replace(bs,“-$1”).toLowerCase(),(d=a.ownerDocument.defaultView)&&(e=d.getComputedStyle(a,null))&&(c=e.getPropertyValue(b),c===“”&&!f.contains(a.ownerDocument.documentElement,a)&&(c=f.style(a,b)));return +c}),c.documentElement.currentStyle&&(bB=function(a,b){var c,d,e,f=a.currentStyle&&a.currentStyle,g=a.style;f===null&&g&&(e=g)&&(f=e),!bt.test(f)&&bu.test(f)&&(c=g.left,d=a.runtimeStyle&&a.runtimeStyle.left,d&&(a.runtimeStyle.left=a.currentStyle.left),g.left=b===“fontSize”?“1em”:f||0,f=g.pixelLeft+“px”,g.left=c,d&&(a.runtimeStyle.left=d));return +f===“”?“auto”:f}),bz=bA||bB,f.expr&&f.expr.filters&&(f.expr.filters.hidden=function(a){var +b=a.offsetWidth,c=a.offsetHeight;return +b===0&&c===0||!f.support.reliableHiddenOffsets&&(a.style&&a.style.display||f.css(a,“display”))===“none”},f.expr.filters.visible=function(a){return!f.expr.filters.hidden(a)});var +bD=/%20/g,bE=/$/,bF=/r?n/g,bG=/#.*$/,bH=/^(.*?):[ +t]*([^rn]*)r?$/mg,bI=/^(?:color|date|datetime|datetime-local|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,bJ=/^(?:about|app|app-storage|.+-extension|file|res|widget):$/,bK=/^(?:GET|HEAD)$/,bL=/^///,bM=/?/,bN=/*(?:(?!</script>)<*)*</script>/gi,bO=/^(?:select|textarea)/i,bP=/s+/,bQ=/()_=*/,bR=/^(+:)(?://([^/?#:]*)(?::(d+))?)?/,bS=f.fn.load,bT={},bU={},bV,bW,bX=+[”*“];try{bV=e.href}catch(bY){bV=c.createElement(”a“),bV.href=”“,bV=bV.href}bW=bR.exec(bV.toLowerCase())||[],f.fn.extend({load:function(a,c,d){if(typeof +a!=”string“&&bS)return +bS.apply(this,arguments);if(!this.length)return this;var e=a.indexOf(” +“);if(e>=0){var g=a.slice(e,a.length);a=a.slice(0,e)}var +h=”GET“;c&&(f.isFunction©?(d=c,c=b):typeof +c==”object“&&(c=f.param(c,f.ajaxSettings.traditional),h=”POST“));var +i=this;f.ajax({url:a,type:h,dataType:”html“,data:c,complete:function(a,b,c){c=a.responseText,a.isResolved()&&(a.done(function(a){c=a}),i.html(g?f(”

“).append(c.replace(bN,”“)).find(g):c)),d&&i.each(d,)}});return +this},serialize:function(){return +f.param(this.serializeArray())},serializeArray:function(){return +this.map(function(){return +this.elements?f.makeArray(this.elements):this}).filter(function(){return +this.name&&!this.disabled&&(this.checked||bO.test(this.nodeName)||bI.test(this.type))}).map(function(a,b){var +c=f(this).val();return +c==null?null:f.isArray©?f.map(c,function(a,c){return{name:b.name,value:a.replace(bF,”rn“)}}):{name:b.name,value:c.replace(bF,”rn“)}}).get()}}),f.each(”ajaxStart +ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend“.split(” +“),function(a,b){f.fn=function(a){return this.on(b,a)}}),f.each(,function(a,c){f=function(a,d,e,g){f.isFunction(d)&&(g=g||e,e=d,d=b);return +f.ajax({type:c,url:a,data:d,success:e,dataType:g})}}),f.extend({getScript:function(a,c){return +f.get(a,b,c,”script“)},getJSON:function(a,b,c){return +f.get(a,b,c,”json“)},ajaxSetup:function(a,b){b?b_(a,f.ajaxSettings):(b=a,a=f.ajaxSettings),b_(a,b);return +a},ajaxSettings:{url:bV,isLocal:bJ.test(bW),global:!0,type:”GET“,contentType:”application/x-www-form-urlencoded“,processData:!0,async:!0,accepts:{xml:”application/xml, +text/xml“,html:”text/html“,text:”text/plain“,json:”application/json, +text/javascript“,”*“:bX},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:”responseXML“,text:”responseText“},converters:{”* +text“:a.String,”text html“:!0,”text json“:f.parseJSON,”text +xml“:f.parseXML},flatOptions:{context:!0,url:!0}},ajaxPrefilter:bZ(bT),ajaxTransport:bZ(bU),ajax:function(a,c){function +w(a,c,l,m){if(s!==2){s=2,q&&clearTimeout(q),p=b,n=m||”“,v.readyState=a>0?4:0;var +o,r,u,w=c,x=l?cb(d,v,l):b,y,z;if(a>=200&&a<300||a===304){if(d.ifModified){if(y=v.getResponseHeader(”Last-Modified“))f.lastModified=y;if(z=v.getResponseHeader(”Etag“))f.etag=z}if(a===304)w=”notmodified“,o=!0;else +try{r=cc(d,x),w=”success“,o=!0}catch(A){w=”parsererror“,u=A}}else{u=w;if(!w||a)w=”error“,a<0&&(a=0)}v.status=a,v.statusText=”“+(c||w),o?h.resolveWith(e,):h.rejectWith(e,),v.statusCode(j),j=b,t&&g.trigger(”ajax“+(o?”Success“:”Error“),),i.fireWith(e,),t&&(g.trigger(”ajaxComplete“,),–f.active||f.event.trigger(”ajaxStop“))}}typeof +a==”object“&&(c=a,a=b),c=c||{};var +d=f.ajaxSetup({},c),e=d.context||d,g=e!==d&&(e.nodeType||e +instanceof f)?f(e):f.event,h=f.Deferred(),i=f.Callbacks(”once +memory“),j=d.statusCode||{},k,l={},m={},n,o,p,q,r,s=0,t,u,v={readyState:0,setRequestHeader:function(a,b){if(!s){var +c=a.toLowerCase();a=m=m||a,l=b}return this},getAllResponseHeaders:function(){return +s===2?n:null},getResponseHeader:function(a){var c;if(s===2){if(!o){o={};while(c=bH.exec(n))o[c.toLowerCase()]=c}c=o}return +c===b?null:c},overrideMimeType:function(a){s||(d.mimeType=a);return +this},abort:function(a){a=a||”abort“,p&&p.abort(a),w(0,a);return +this}};h.promise(v),v.success=v.done,v.error=v.fail,v.complete=i.add,v.statusCode=function(a){if(a){var +b;if(s<2)for(b in a)j=[j,a];else b=a,v.then(b,b)}return this},d.url=((a||d.url)+”“).replace(bG,”“).replace(bL,bW+”//“),d.dataTypes=f.trim(d.dataType||”*“).toLowerCase().split(bP),d.crossDomain==null&&(r=bR.exec(d.url.toLowerCase()),d.crossDomain=!(!r||r==bW&&r==bW&&(r||(r===”“?80:443))==(bW[3]||(bW[1]===”http:“?80:443)))),d.data&&d.processData&&typeof +d.data!=”string“&&(d.data=f.param(d.data,d.traditional)),b$(bT,d,c,v);if(s===2)return!1;t=d.global,d.type=d.type.toUpperCase(),d.hasContent=!bK.test(d.type),t&&f.active++===0&&f.event.trigger(”ajaxStart“);if(!d.hasContent){d.data&&(d.url+=(bM.test(d.url)?”&“:”?“)+d.data,delete +d.data),k=d.url;if(d.cache===!1){var +x=f.now(),y=d.url.replace(bQ,”$1_=“+x);d.url=y+(y===d.url?(bM.test(d.url)?”&“:”?“)+”_=“+x:”“)}}(d.data&&d.hasContent&&d.contentType!==!1||c.contentType)&&v.setRequestHeader(”Content-Type“,d.contentType),d.ifModified&&(k=k||d.url,f.lastModified&&v.setRequestHeader(”If-Modified-Since“,f.lastModified),f.etag&&v.setRequestHeader(”If-None-Match“,f.etag)),v.setRequestHeader(”Accept“,d.dataTypes&&d.accepts[d.dataTypes]?d.accepts[d.dataTypes]+(d.dataTypes!==”*“?”, +“bX”; q=0.01“:”“):d.accepts);for(u in d.headers)v.setRequestHeader(u,d.headers);if(d.beforeSend&&(d.beforeSend.call(e,v,d)===!1||s===2)){v.abort();return!1}for(u +in{success:1,error:1,complete:1})v(d);p=b$(bU,d,c,v);if(!p)w(-1,”No Transport“);else{v.readyState=1,t&&g.trigger(”ajaxSend“,),d.async&&d.timeout>0&&(q=setTimeout(function(){v.abort(”timeout“)},d.timeout));try{s=1,p.send(l,w)}catch(z){if(s<2)w(-1,z);else +throw z}}return v},param:function(a,c){var d=[],e=function(a,b){b=f.isFunction(b)?b():b,d=encodeURIComponent(a)+”=“+encodeURIComponent(b)};c===b&&(c=f.ajaxSettings.traditional);if(f.isArray(a)||a.jquery&&!f.isPlainObject(a))f.each(a,function(){e(this.name,this.value)});else +for(var g in a)ca(g,a,c,e);return +d.join(”&“).replace(bD,”+“)}}),f.extend({active:0,lastModified:{},etag:{}});var +cd=f.now(),ce=/(=)?(&|$)|??/i;f.ajaxSetup({jsonp:”callback“,jsonpCallback:function(){return +f.expando+”_“cd+}}),f.ajaxPrefilter(”json +jsonp“,function(b,c,d){var +e=b.contentType===”application/x-www-form-urlencoded“&&typeof b.data==”string“;if(b.dataTypes===”jsonp“||b.jsonp!==!1&&(ce.test(b.url)||e&&ce.test(b.data))){var +g,h=b.jsonpCallback=f.isFunction(b.jsonpCallback)?b.jsonpCallback():b.jsonpCallback,i=a,j=b.url,k=b.data,l=”$1“h”$2“;b.jsonp!==!1&&(j=j.replace(ce,l),b.url===j&&(e&&(k=k.replace(ce,l)),b.data===k&&(j+=(/?/.test(j)?”&“:”?“)b.jsonp”=“+h))),b.url=j,b.data=k,a=function(a){g=},d.always(function(){a=i,g&&f.isFunction(i)&&a(g)}),b.converters[”script json“]=function(){g||f.error(h+” was +not called“);return g},b.dataTypes=”json“;return”script“}}),f.ajaxSetup({accepts:{script:”text/javascript, +application/javascript, application/ecmascript, +application/x-ecmascript“},contents:{script:/javascript|ecmascript/},converters:{”text +script“:function(a){f.globalEval(a);return +a}}}),f.ajaxPrefilter(”script“,function(a){a.cache===b&&(a.cache=!1),a.crossDomain&&(a.type=”GET“,a.global=!1)}),f.ajaxTransport(”script“,function(a){if(a.crossDomain){var +d,e=c.head||c.getElementsByTagName(”head“)||c.documentElement;return{send:function(f,g){d=c.createElement(”script“),d.async=”async“,a.scriptCharset&&(d.charset=a.scriptCharset),d.src=a.url,d.onload=d.onreadystatechange=function(a,c){if(c||!d.readyState||/loaded|complete/.test(d.readyState))d.onload=d.onreadystatechange=null,e&&d.parentNode&&e.removeChild(d),d=b,c||g(200,”success“)},e.insertBefore(d,e.firstChild)},abort:function(){d&&d.onload(0,1)}}}});var +cf=a.ActiveXObject?function(){for(var a in ch)ch(0,1)}:!1,cg=0,ch;f.ajaxSettings.xhr=a.ActiveXObject?function(){return!this.isLocal&&ci()||cj()}:ci,function(a){f.extend(f.support,{ajax:!!a,cors:!!a&&”withCredentials“in +a})}(f.ajaxSettings.xhr()),f.support.ajax&&f.ajaxTransport(function©{if(!c.crossDomain||f.support.cors){var +d;return{send:function(e,g){var +h=c.xhr(),i,j;c.username?h.open(c.type,c.url,c.async,c.username,c.password):h.open(c.type,c.url,c.async);if(c.xhrFields)for(j +in c.xhrFields)h=c.xhrFields;c.mimeType&&h.overrideMimeType&&h.overrideMimeType(c.mimeType),!c.crossDomain&&!e&&(e=”XMLHttpRequest“);try{for(j in e)h.setRequestHeader(j,e)}catch(k){}h.send(c.hasContent&&c.data||null),d=function(a,e){var +j,k,l,m,n;try{if(d&&(e||h.readyState===4)){d=b,i&&(h.onreadystatechange=f.noop,cf&&delete +ch);if(e)h.readyState!==4&&h.abort();else{j=h.status,l=h.getAllResponseHeaders(),m={},n=h.responseXML,n&&n.documentElement&&(m.xml=n),m.text=h.responseText;try{k=h.statusText}catch(o){k=”“}!j&&c.isLocal&&!c.crossDomain?j=m.text?200:404:j===1223&&(j=204)}}}catch(p){e||g(-1,p)}m&&g(j,k,m,l)},!c.async||h.readyState===4?d():(i=++cg,cf&&(ch||(ch={},f(a).unload(cf)),ch=d),h.onreadystatechange=d)},abort:function(){d&&d(0,1)}}}});var +ck={},cl,cm,cn=/^(?:toggle|show|hide)$/,co=/^(=)?([d+.-]+)(*)$/i,cp,cq=[,[”width“,”marginLeft“,”marginRight“,”paddingLeft“,”paddingRight“],],cr;f.fn.extend({show:function(a,b,c){var +d,e;if(a||a===0)return this.animate(cu(”show“,3),a,b,c);for(var g=0,h=this.length;g,d.style&&(e=d.style.display,!f._data(d,”olddisplay“)&&e===”none“&&(e=d.style.display=”“),e===”“&&f.css(d,”display“)===”none“&&f._data(d,”olddisplay“,cv(d.nodeName)));for(g=0;g<h;g++){d=this;if(d.style){e=d.style.display;if(e===”“||e===”none“)d.style.display=f._data(d,”olddisplay“)||”“}}return +this},hide:function(a,b,c){if(a||a===0)return +this.animate(cu(”hide“,3),a,b,c);var d,e,g=0,h=this.length;for(;g,d.style&&(e=f.css(d,”display“),e!==”none“&&!f._data(d,”olddisplay“)&&f._data(d,”olddisplay“,e));for(g=0;g.style&&(this.style.display=”none“);return +this},_toggle:f.fn.toggle,toggle:function(a,b,c){var d=typeof +a==”boolean“;f.isFunction(a)&&f.isFunction(b)?this._toggle.apply(this,arguments):a==null||d?this.each(function(){var +b=d?a:f(this).is(”:hidden“);f(this)()}):this.animate(cu(”toggle“,3),a,b,c);return +this},fadeTo:function(a,b,c,d){return +this.filter(”:hidden“).css(”opacity“,0).show().end().animate({opacity:b},a,c,d)},animate:function(a,b,c,d){function +g(){e.queue===!1&&f._mark(this);var +b=f.extend({},e),c=this.nodeType===1,d=c&&f(this).is(”:hidden“),g,h,i,j,k,l,m,n,o;b.animatedProperties={};for(i +in a){g=f.camelCase(i),i!==g&&(a=a,delete +a),h=a,f.isArray(h)?(b.animatedProperties=h,h=a=h):b.animatedProperties=b.specialEasing&&b.specialEasing||b.easing||”swing“;if(h===”hide“&&d||h===”show“&&!d)return +b.complete.call(this);c&&(g===”height“||g===”width“)&&(b.overflow=,f.css(this,”display“)===”inline“&&f.css(this,”float“)===”none“&&(!f.support.inlineBlockNeedsLayout||cv(this.nodeName)===”inline“?this.style.display=”inline-block“:this.style.zoom=1))}b.overflow!=null&&(this.style.overflow=”hidden“);for(i +in a)j=new f.fx(this,b,i),h=a,cn.test(h)?(o=f._data(this,”toggle“+i)||(h===”toggle“?d?”show“:”hide“:0),o?(f._data(this,”toggle“+i,o===”show“?”hide“:”show“),j()):j()):(k=co.exec(h),l=j.cur(),k?(m=parseFloat(k),n=k||(f.cssNumber?”“:”px“),n!==”px“&&(f.style(this,i,(m||1)+n),l=(m||1)/j.cur()*l,f.style(this,i,l+n)),k&&(m=(k===”-=“?-1:1)*m+l),j.custom(l,m,n)):j.custom(l,h,”“));return!0}var +e=f.speed(b,c,d);if(f.isEmptyObject(a))return this.each(e.complete,);a=f.extend({},a);return +e.queue===!1?this.each(g):this.queue(e.queue,g)},stop:function(a,c,d){typeof +a!=”string“&&(d=c,c=a,a=b),c&&a!==!1&&this.queue(a||”fx“,[]);return +this.each(function(){function h(a,b,c){var e=b;f.removeData(a,c,!0),e.stop(d)}var +b,c=!1,e=f.timers,g=f._data(this);d||f._unmark(!0,this);if(a==null)for(b in +g)g&&g.stop&&b.indexOf(”.run“)===b.length-4&&h(this,g,b);else +g&&g.stop&&h(this,g,b);for(b=e.length;b–;)e.elem===this&&(a==null||e.queue===a)&&(d?e(!0):e.saveState(),c=!0,e.splice(b,1));(!d||!c)&&f.dequeue(this,a)})}}),f.each({slideDown:cu(”show“,1),slideUp:cu(”hide“,1),slideToggle:cu(”toggle“,1),fadeIn:{opacity:”show“},fadeOut:{opacity:”hide“},fadeToggle:{opacity:”toggle“}},function(a,b){f.fn=function(a,c,d){return +this.animate(b,a,c,d)}}),f.extend({speed:function(a,b,c){var +d=a&&typeof +a==”object“?f.extend({},a):{complete:c||!c&&b||f.isFunction(a)&&a,duration:a,easing:c&&b||b&&!f.isFunction(b)&&b};d.duration=f.fx.off?0:typeof +d.duration==”number“?d.duration:d.duration in f.fx.speeds?f.fx.speeds:f.fx.speeds._default;if(d.queue==null||d.queue===!0)d.queue=”fx“;d.old=d.complete,d.complete=function(a){f.isFunction(d.old)&&d.old.call(this),d.queue?f.dequeue(this,d.queue):a!==!1&&f._unmark(this)};return +d},easing:{linear:function(a,b,c,d){return +c+d*a},swing:function(a,b,c,d){return(-Math.cos(a*Math.PI)/2+.5)*d+c}},timers:[],fx:function(a,b,c){this.options=b,this.elem=a,this.prop=c,b.orig=b.orig||{}}}),f.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this),(f.fx.step||f.fx.step._default)(this)},cur:function(){if(this.elem!=null&&(!this.elem.style||this.elem.style==null))return +this.elem;var a,b=f.css(this.elem,this.prop);return +isNaN(a=parseFloat(b))?!b||b===”auto“?0:b:a},custom:function(a,c,d){function +h(a){return e.step(a)}var e=this,g=f.fx;this.startTime=cr||cs(),this.end=c,this.now=this.start=a,this.pos=this.state=0,this.unit=d||this.unit||(f.cssNumber?”“:”px“),h.queue=this.options.queue,h.elem=this.elem,h.saveState=function(){e.options.hide&&f._data(e.elem,”fxshow“+e.prop)===b&&f._data(e.elem,”fxshow“+e.prop,e.start)},h()&&f.timers.push(h)&&!cp&&(cp=setInterval(g.tick,g.interval))},show:function(){var +a=f._data(this.elem,”fxshow“+this.prop);this.options.orig=a||f.style(this.elem,this.prop),this.options.show=!0,a!==b?this.custom(this.cur(),a):this.custom(this.prop===”width“||this.prop===”height“?1:0,this.cur()),f(this.elem).show()},hide:function(){this.options.orig=f._data(this.elem,”fxshow“+this.prop)||f.style(this.elem,this.prop),this.options.hide=!0,this.custom(this.cur(),0)},step:function(a){var +b,c,d,e=cr||cs(),g=!0,h=this.elem,i=this.options;if(a||e>=i.duration+this.startTime){this.now=this.end,this.pos=this.state=1,this.update(),i.animatedProperties=!0;for(b +in i.animatedProperties)i.animatedProperties!==!0&&(g=!1);if(g){i.overflow!=null&&!f.support.shrinkWrapBlocks&&f.each(,function(a,b){h.style=i.overflow}),i.hide&&f(h).hide();if(i.hide||i.show)for(b +in i.animatedProperties)f.style(h,b,i.orig),f.removeData(h,”fxshow“+b,!0),f.removeData(h,”toggle“+b,!0);d=i.complete,d&&(i.complete=!1,d.call(h))}return!1}i.duration==Infinity?this.now=e:(c=e-this.startTime,this.state=c/i.duration,this.pos=f.easing[i.animatedProperties](this.state,c,0,1,i.duration),this.now=this.start+(this.end-this.start)*this.pos),this.update();return!0}},f.extend(f.fx,{tick:function(){var +a,b=f.timers,c=0;for(;c,!a()&&b===a&&b.splice(c–,1);b.length||f.fx.stop()},interval:13,stop:function(){clearInterval(cp),cp=null},speeds:{slow:600,fast:200,_default:400},step:{opacity:function(a){f.style(a.elem,”opacity“,a.now)},_default:function(a){a.elem.style&&a.elem.style!=null?a.elem.style=a.now+a.unit:a.elem=a.now}}}),f.each(,function(a,b){f.fx.step=function(a){f.style(a.elem,b,Math.max(0,a.now)+a.unit)}}),f.expr&&f.expr.filters&&(f.expr.filters.animated=function(a){return +f.grep(f.timers,function(b){return a===b.elem}).length});var +cw=/^t(?:able|d|h)$/i,cx=/^(?:body|html)$/i;”getBoundingClientRect“in +c.documentElement?f.fn.offset=function(a){var b=this,c;if(a)return +this.each(function(b){f.offset.setOffset(this,a,b)});if(!b||!b.ownerDocument)return +null;if(b===b.ownerDocument.body)return +f.offset.bodyOffset(b);try{c=b.getBoundingClientRect()}catch(d){}var +e=b.ownerDocument,g=e.documentElement;if(!c||!f.contains(g,b))return +c?{top:c.top,left:c.left}:{top:0,left:0};var +h=e.body,i=cy(e),j=g.clientTop||h.clientTop||0,k=g.clientLeft||h.clientLeft||0,l=i.pageYOffset||f.support.boxModel&&g.scrollTop||h.scrollTop,m=i.pageXOffset||f.support.boxModel&&g.scrollLeft||h.scrollLeft,n=c.top+l-j,o=c.left+m-k;return{top:n,left:o}}:f.fn.offset=function(a){var +b=this;if(a)return +this.each(function(b){f.offset.setOffset(this,a,b)});if(!b||!b.ownerDocument)return +null;if(b===b.ownerDocument.body)return f.offset.bodyOffset(b);var +c,d=b.offsetParent,e=b,g=b.ownerDocument,h=g.documentElement,i=g.body,j=g.defaultView,k=j?j.getComputedStyle(b,null):b.currentStyle,l=b.offsetTop,m=b.offsetLeft;while((b=b.parentNode)&&b!==i&&b!==h){if(f.support.fixedPosition&&k.position===”fixed“)break;c=j?j.getComputedStyle(b,null):b.currentStyle,l-=b.scrollTop,m-=b.scrollLeft,b===d&&(l+=b.offsetTop,m+=b.offsetLeft,f.support.doesNotAddBorder&&(!f.support.doesAddBorderForTableAndCells||!cw.test(b.nodeName))&&(l+=parseFloat(c.borderTopWidth)||0,m+=parseFloat(c.borderLeftWidth)||0),e=d,d=b.offsetParent),f.support.subtractsBorderForOverflowNotVisible&&c.overflow!==”visible“&&(l+=parseFloat(c.borderTopWidth)||0,m+=parseFloat(c.borderLeftWidth)||0),k=c}if(k.position===”relative“||k.position===”static“)l+=i.offsetTop,m+=i.offsetLeft;f.support.fixedPosition&&k.position===”fixed“&&(l+=Math.max(h.scrollTop,i.scrollTop),m+=Math.max(h.scrollLeft,i.scrollLeft));return{top:l,left:m}},f.offset={bodyOffset:function(a){var +b=a.offsetTop,c=a.offsetLeft;f.support.doesNotIncludeMarginInBodyOffset&&(b+=parseFloat(f.css(a,”marginTop“))||0,c+=parseFloat(f.css(a,”marginLeft“))||0);return{top:b,left:c}},setOffset:function(a,b,c){var +d=f.css(a,”position“);d===”static“&&(a.style.position=”relative“);var +e=f(a),g=e.offset(),h=f.css(a,”top“),i=f.css(a,”left“),j=(d===”absolute“||d===”fixed“)&&f.inArray(”auto“,)>-1,k={},l={},m,n;j?(l=e.position(),m=l.top,n=l.left):(m=parseFloat(h)||0,n=parseFloat(i)||0),f.isFunction(b)&&(b=b.call(a,c,g)),b.top!=null&&(k.top=b.top-g.top+m),b.left!=null&&(k.left=b.left-g.left+n),”using“in +b?b.using.call(a,k):e.css(k)}},f.fn.extend({position:function(){if(!this)return null;var a=this,b=this.offsetParent(),c=this.offset(),d=cx.test(b.nodeName)?{top:0,left:0}:b.offset();c.top-=parseFloat(f.css(a,”marginTop“))||0,c.left-=parseFloat(f.css(a,”marginLeft“))||0,d.top+=parseFloat(f.css(b,”borderTopWidth“))||0,d.left+=parseFloat(f.css(b,”borderLeftWidth“))||0;return{top:c.top-d.top,left:c.left-d.left}},offsetParent:function(){return +this.map(function(){var +a=this.offsetParent||c.body;while(a&&!cx.test(a.nodeName)&&f.css(a,”position“)===”static“)a=a.offsetParent;return +a})}}),f.each(,function(a,c){var d=”scroll“+c;f.fn=function©{var e,g;if(c===b){e=this;if(!e)return null;g=cy(e);return g?”pageXOffset“in g?g:f.support.boxModel&&g.document.documentElement||g.document.body:e}return +this.each(function(){g=cy(this),g?g.scrollTo(a?f(g).scrollLeft():c,a?c:f(g).scrollTop()):this=c})}}),f.each(,function(a,c){var d=c.toLowerCase();f.fn=function(){var a=this;return a?a.style?parseFloat(f.css(a,d,”padding“)):this():null},f.fn=function(a){var b=this;return b?b.style?parseFloat(f.css(b,d,a?”margin“:”border“)):this():null},f.fn=function(a){var e=this;if(!e)return +a==null?null:this;if(f.isFunction(a))return this.each(function(b){var c=f(this);c(a.call(this,b,c()))});if(f.isWindow(e)){var g=e.document.documentElement,h=e.document.body;return +e.document.compatMode===”CSS1Compat“&&g||h&&h||g}if(e.nodeType===9)return +Math.max(e.documentElement,e.body,e.documentElement,e.body,e.documentElement);if(a===b){var +i=f.css(e,d),j=parseFloat(i);return f.isNumeric(j)?j:i}return +this.css(d,typeof a==”string“?a:a+”px“)}}),a.jQuery=a.$=f,typeof +define==”function“&&define.amd&&define.amd.jQuery&&define(”jquery“,[],function(){return +f})})(window);

+
+ + + + + diff --git a/doc/docs/method_list_html.html b/doc/docs/method_list_html.html new file mode 100644 index 00000000..6119cd3f --- /dev/null +++ b/doc/docs/method_list_html.html @@ -0,0 +1,2575 @@ + + + + + + +method_list.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta charset="utf-8" />
+
+    <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
+
+    <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
+
+    <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+    <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+
+  <title>Method List</title>
+  <base id="base_target" target="_parent" />
+</head>
+<body>
+  <div id="content">
+    <div class="fixed_header">
+      <h1 id="full_list_header">Method List</h1>
+      <div id="full_list_nav">
+
+          <span><a target="_self" href="class_list.html">
+            Classes
+          </a></span>
+
+          <span><a target="_self" href="method_list.html">
+            Methods
+          </a></span>
+
+          <span><a target="_self" href="file_list.html">
+            Files
+          </a></span>
+
+      </div>
+
+      <div id="search">Search: <input type="text" /></div>
+    </div>
+
+    <ul id="full_list" class="method">
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/MiddleWare/Stack.html#adapter=-instance_method" title="DropboxApi::MiddleWare::Stack#adapter= (method)">#adapter=</a></span>
+    <small>DropboxApi::MiddleWare::Stack</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span>
+    <small>DropboxApi::Endpoints::Base</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/AddFileMember.html#add_file_member-instance_method" title="DropboxApi::Endpoints::Sharing::AddFileMember#add_file_member (method)">#add_file_member</a></span>
+    <small>DropboxApi::Endpoints::Sharing::AddFileMember</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#add_file_member-instance_method" title="DropboxApi::Client#add_file_member (method)">#add_file_member</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#add_folder_member-instance_method" title="DropboxApi::Client#add_folder_member (method)">#add_folder_member</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/AddFolderMember.html#add_folder_member-instance_method" title="DropboxApi::Endpoints::Sharing::AddFolderMember#add_folder_member (method)">#add_folder_member</a></span>
+    <small>DropboxApi::Endpoints::Sharing::AddFolderMember</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/MiddleWare/Stack.html#append-instance_method" title="DropboxApi::MiddleWare::Stack#append (method)">#append</a></span>
+    <small>DropboxApi::MiddleWare::Stack</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/MiddleWare/Stack.html#apply-instance_method" title="DropboxApi::MiddleWare::Stack#apply (method)">#apply</a></span>
+    <small>DropboxApi::MiddleWare::Stack</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SaveUrlResult.html#async_job_id-instance_method" title="DropboxApi::Results::SaveUrlResult#async_job_id (method)">#async_job_id</a></span>
+    <small>DropboxApi::Results::SaveUrlResult</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/ListFolderLongpollResult.html#backoff-instance_method" title="DropboxApi::Results::ListFolderLongpollResult#backoff (method)">#backoff</a></span>
+    <small>DropboxApi::Results::ListFolderLongpollResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Errors/TooManyRequestsError.html#build-class_method" title="DropboxApi::Errors::TooManyRequestsError.build (method)">build</a></span>
+    <small>DropboxApi::Errors::TooManyRequestsError</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Errors/BasicError.html#build-class_method" title="DropboxApi::Errors::BasicError.build (method)">build</a></span>
+    <small>DropboxApi::Errors::BasicError</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ConnectionBuilder.html#build-instance_method" title="DropboxApi::ConnectionBuilder#build (method)">#build</a></span>
+    <small>DropboxApi::ConnectionBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ResultBuilder.html#build-instance_method" title="DropboxApi::ResultBuilder#build (method)">#build</a></span>
+    <small>DropboxApi::ResultBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/RpcNotify.html#build_connection-instance_method" title="DropboxApi::Endpoints::RpcNotify#build_connection (method)">#build_connection</a></span>
+    <small>DropboxApi::Endpoints::RpcNotify</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/ContentUpload.html#build_connection-instance_method" title="DropboxApi::Endpoints::ContentUpload#build_connection (method)">#build_connection</a></span>
+    <small>DropboxApi::Endpoints::ContentUpload</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/RpcContent.html#build_connection-instance_method" title="DropboxApi::Endpoints::RpcContent#build_connection (method)">#build_connection</a></span>
+    <small>DropboxApi::Endpoints::RpcContent</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Rpc.html#build_connection-instance_method" title="DropboxApi::Endpoints::Rpc#build_connection (method)">#build_connection</a></span>
+    <small>DropboxApi::Endpoints::Rpc</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/ContentDownload.html#build_connection-instance_method" title="DropboxApi::Endpoints::ContentDownload#build_connection (method)">#build_connection</a></span>
+    <small>DropboxApi::Endpoints::ContentDownload</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#build_copy_batch-instance_method" title="DropboxScaffoldBuilder#build_copy_batch (method)">#build_copy_batch</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#build_create_file_request-instance_method" title="DropboxScaffoldBuilder#build_create_file_request (method)">#build_create_file_request</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#build_delete-instance_method" title="DropboxScaffoldBuilder#build_delete (method)">#build_delete</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/GetThumbnailBatch.html#build_entries_params-instance_method" title="DropboxApi::Endpoints::Files::GetThumbnailBatch#build_entries_params (method)">#build_entries_params</a></span>
+    <small>DropboxApi::Endpoints::Files::GetThumbnailBatch</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ResultBuilder.html#build_error-instance_method" title="DropboxApi::ResultBuilder#build_error (method)">#build_error</a></span>
+    <small>DropboxApi::ResultBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/CommitInfo.html#build_from_options-class_method" title="DropboxApi::Metadata::CommitInfo.build_from_options (method)">build_from_options</a></span>
+    <small>DropboxApi::Metadata::CommitInfo</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/AddMember.html#build_from_string-class_method" title="DropboxApi::Metadata::AddMember.build_from_string (method)">build_from_string</a></span>
+    <small>DropboxApi::Metadata::AddMember</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#build_get_metadata-instance_method" title="DropboxScaffoldBuilder#build_get_metadata (method)">#build_get_metadata</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#build_get_shared_link_metadata-instance_method" title="DropboxScaffoldBuilder#build_get_shared_link_metadata (method)">#build_get_shared_link_metadata</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#build_get_thumbnail_batch-instance_method" title="DropboxScaffoldBuilder#build_get_thumbnail_batch (method)">#build_get_thumbnail_batch</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#build_list_folder-instance_method" title="DropboxScaffoldBuilder#build_list_folder (method)">#build_list_folder</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/ContentDownload.html#build_request-instance_method" title="DropboxApi::Endpoints::ContentDownload#build_request (method)">#build_request</a></span>
+    <small>DropboxApi::Endpoints::ContentDownload</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/ContentUpload.html#build_request-instance_method" title="DropboxApi::Endpoints::ContentUpload#build_request (method)">#build_request</a></span>
+    <small>DropboxApi::Endpoints::ContentUpload</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>
+    <small>DropboxApi::Endpoints::Rpc</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#build_search-instance_method" title="DropboxScaffoldBuilder#build_search (method)">#build_search</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#build_upload-instance_method" title="DropboxScaffoldBuilder#build_upload (method)">#build_upload</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#build_upload_by_chunks-instance_method" title="DropboxScaffoldBuilder#build_upload_by_chunks (method)">#build_upload_by_chunks</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/MiddleWare/PathRoot.html#call-instance_method" title="DropboxApi::MiddleWare::PathRoot#call (method)">#call</a></span>
+    <small>DropboxApi::MiddleWare::PathRoot</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/MiddleWare/DecodeResult.html#call-instance_method" title="DropboxApi::MiddleWare::DecodeResult#call (method)">#call</a></span>
+    <small>DropboxApi::MiddleWare::DecodeResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ConnectionBuilder.html#can_refresh_access_token%3F-instance_method" title="DropboxApi::ConnectionBuilder#can_refresh_access_token? (method)">#can_refresh_access_token?</a></span>
+    <small>DropboxApi::ConnectionBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Field.html#cast-instance_method" title="DropboxApi::Metadata::Field#cast (method)">#cast</a></span>
+    <small>DropboxApi::Metadata::Field</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/ListFolderLongpollResult.html#changes-instance_method" title="DropboxApi::Results::ListFolderLongpollResult#changes (method)">#changes</a></span>
+    <small>DropboxApi::Results::ListFolderLongpollResult</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/SharedLink.html#check_validity-instance_method" title="DropboxApi::Metadata::SharedLink#check_validity (method)">#check_validity</a></span>
+    <small>DropboxApi::Metadata::SharedLink</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/WriteMode.html#check_validity-instance_method" title="DropboxApi::Metadata::WriteMode#check_validity (method)">#check_validity</a></span>
+    <small>DropboxApi::Metadata::WriteMode</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#client-instance_method" title="DropboxScaffoldBuilder#client (method)">#client</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#clobber-instance_method" title="DropboxScaffoldBuilder#clobber (method)">#clobber</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#copy-instance_method" title="DropboxApi::Client#copy (method)">#copy</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/Copy.html#copy-instance_method" title="DropboxApi::Endpoints::Files::Copy#copy (method)">#copy</a></span>
+    <small>DropboxApi::Endpoints::Files::Copy</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/CopyBatch.html#copy_batch-instance_method" title="DropboxApi::Endpoints::Files::CopyBatch#copy_batch (method)">#copy_batch</a></span>
+    <small>DropboxApi::Endpoints::Files::CopyBatch</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#copy_batch-instance_method" title="DropboxApi::Client#copy_batch (method)">#copy_batch</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/CopyBatchCheck.html#copy_batch_check-instance_method" title="DropboxApi::Endpoints::Files::CopyBatchCheck#copy_batch_check (method)">#copy_batch_check</a></span>
+    <small>DropboxApi::Endpoints::Files::CopyBatchCheck</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#copy_batch_check-instance_method" title="DropboxApi::Client#copy_batch_check (method)">#copy_batch_check</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/GetCopyReferenceResult.html#copy_reference-instance_method" title="DropboxApi::Results::GetCopyReferenceResult#copy_reference (method)">#copy_reference</a></span>
+    <small>DropboxApi::Results::GetCopyReferenceResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#copy_reference_get-instance_method" title="DropboxApi::Client#copy_reference_get (method)">#copy_reference_get</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/CopyReferenceGet.html#copy_reference_get-instance_method" title="DropboxApi::Endpoints::Files::CopyReferenceGet#copy_reference_get (method)">#copy_reference_get</a></span>
+    <small>DropboxApi::Endpoints::Files::CopyReferenceGet</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/CopyReferenceSave.html#copy_reference_save-instance_method" title="DropboxApi::Endpoints::Files::CopyReferenceSave#copy_reference_save (method)">#copy_reference_save</a></span>
+    <small>DropboxApi::Endpoints::Files::CopyReferenceSave</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#copy_reference_save-instance_method" title="DropboxApi::Client#copy_reference_save (method)">#copy_reference_save</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/CreateFileRequest.html#create_file_request-instance_method" title="DropboxApi::Endpoints::Files::CreateFileRequest#create_file_request (method)">#create_file_request</a></span>
+    <small>DropboxApi::Endpoints::Files::CreateFileRequest</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#create_file_request-instance_method" title="DropboxApi::Client#create_file_request (method)">#create_file_request</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/CreateFolder.html#create_folder-instance_method" title="DropboxApi::Endpoints::Files::CreateFolder#create_folder (method)">#create_folder</a></span>
+    <small>DropboxApi::Endpoints::Files::CreateFolder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#create_folder-instance_method" title="DropboxApi::Client#create_folder (method)">#create_folder</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#create_folder_batch-instance_method" title="DropboxApi::Client#create_folder_batch (method)">#create_folder_batch</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/CreateFolderBatch.html#create_folder_batch-instance_method" title="DropboxApi::Endpoints::Files::CreateFolderBatch#create_folder_batch (method)">#create_folder_batch</a></span>
+    <small>DropboxApi::Endpoints::Files::CreateFolderBatch</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#create_folder_batch_check-instance_method" title="DropboxApi::Client#create_folder_batch_check (method)">#create_folder_batch_check</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html#create_folder_batch_check-instance_method" title="DropboxApi::Endpoints::Files::CreateFolderBatchCheck#create_folder_batch_check (method)">#create_folder_batch_check</a></span>
+    <small>DropboxApi::Endpoints::Files::CreateFolderBatchCheck</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html#create_shared_link_with_settings-instance_method" title="DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings#create_shared_link_with_settings (method)">#create_shared_link_with_settings</a></span>
+    <small>DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#create_shared_link_with_settings-instance_method" title="DropboxApi::Client#create_shared_link_with_settings (method)">#create_shared_link_with_settings</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SharedFileMembers.html#cursor-instance_method" title="DropboxApi::Results::SharedFileMembers#cursor (method)">#cursor</a></span>
+    <small>DropboxApi::Results::SharedFileMembers</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SearchV2Result.html#cursor-instance_method" title="DropboxApi::Results::SearchV2Result#cursor (method)">#cursor</a></span>
+    <small>DropboxApi::Results::SearchV2Result</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/ListSharedLinksResult.html#cursor-instance_method" title="DropboxApi::Results::ListSharedLinksResult#cursor (method)">#cursor</a></span>
+    <small>DropboxApi::Results::ListSharedLinksResult</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/ListFolderGetLatestCursorResult.html#cursor-instance_method" title="DropboxApi::Results::ListFolderGetLatestCursorResult#cursor (method)">#cursor</a></span>
+    <small>DropboxApi::Results::ListFolderGetLatestCursorResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SharedFolderMembers.html#cursor-instance_method" title="DropboxApi::Results::SharedFolderMembers#cursor (method)">#cursor</a></span>
+    <small>DropboxApi::Results::SharedFolderMembers</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/ListFolderResult.html#cursor-instance_method" title="DropboxApi::Results::ListFolderResult#cursor (method)">#cursor</a></span>
+    <small>DropboxApi::Results::ListFolderResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/MiddleWare/DecodeResult.html#decode-instance_method" title="DropboxApi::MiddleWare::DecodeResult#decode (method)">#decode</a></span>
+    <small>DropboxApi::MiddleWare::DecodeResult</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/Delete.html#delete-instance_method" title="DropboxApi::Endpoints::Files::Delete#delete (method)">#delete</a></span>
+    <small>DropboxApi::Endpoints::Files::Delete</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#delete-instance_method" title="DropboxApi::Client#delete (method)">#delete</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/DeleteBatch.html#delete_batch-instance_method" title="DropboxApi::Endpoints::Files::DeleteBatch#delete_batch (method)">#delete_batch</a></span>
+    <small>DropboxApi::Endpoints::Files::DeleteBatch</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#delete_batch-instance_method" title="DropboxApi::Client#delete_batch (method)">#delete_batch</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/DeleteBatchCheck.html#delete_batch_check-instance_method" title="DropboxApi::Endpoints::Files::DeleteBatchCheck#delete_batch_check (method)">#delete_batch_check</a></span>
+    <small>DropboxApi::Endpoints::Files::DeleteBatchCheck</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#delete_batch_check-instance_method" title="DropboxApi::Client#delete_batch_check (method)">#delete_batch_check</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/Download.html#download-instance_method" title="DropboxApi::Endpoints::Files::Download#download (method)">#download</a></span>
+    <small>DropboxApi::Endpoints::Files::Download</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#download-instance_method" title="DropboxApi::Client#download (method)">#download</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/GetThumbnailBatchResult.html#entries-instance_method" title="DropboxApi::Results::GetThumbnailBatchResult#entries (method)">#entries</a></span>
+    <small>DropboxApi::Results::GetThumbnailBatchResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/ListRevisionsResult.html#entries-instance_method" title="DropboxApi::Results::ListRevisionsResult#entries (method)">#entries</a></span>
+    <small>DropboxApi::Results::ListRevisionsResult</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/ListFolderResult.html#entries-instance_method" title="DropboxApi::Results::ListFolderResult#entries (method)">#entries</a></span>
+    <small>DropboxApi::Results::ListFolderResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ResultBuilder.html#error-instance_method" title="DropboxApi::ResultBuilder#error (method)">#error</a></span>
+    <small>DropboxApi::ResultBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ResultBuilder.html#error_summary-instance_method" title="DropboxApi::ResultBuilder#error_summary (method)">#error_summary</a></span>
+    <small>DropboxApi::ResultBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/GetCopyReferenceResult.html#expires-instance_method" title="DropboxApi::Results::GetCopyReferenceResult#expires (method)">#expires</a></span>
+    <small>DropboxApi::Results::GetCopyReferenceResult</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Base.html#field-class_method" title="DropboxApi::Metadata::Base.field (method)">field</a></span>
+    <small>DropboxApi::Metadata::Base</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Base.html#fields-class_method" title="DropboxApi::Metadata::Base.fields (method)">fields</a></span>
+    <small>DropboxApi::Metadata::Base</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/GetTemporaryLinkResult.html#file-instance_method" title="DropboxApi::Results::GetTemporaryLinkResult#file (method)">#file</a></span>
+    <small>DropboxApi::Results::GetTemporaryLinkResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Errors/BasicError.html#find_subtype-class_method" title="DropboxApi::Errors::BasicError.find_subtype (method)">find_subtype</a></span>
+    <small>DropboxApi::Errors::BasicError</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ChunkedUploader.html#finish-instance_method" title="DropboxApi::ChunkedUploader#finish (method)">#finish</a></span>
+    <small>DropboxApi::ChunkedUploader</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#fixtures_path-class_method" title="DropboxScaffoldBuilder.fixtures_path (method)">fixtures_path</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Field.html#force_cast-instance_method" title="DropboxApi::Metadata::Field#force_cast (method)">#force_cast</a></span>
+    <small>DropboxApi::Metadata::Field</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#generate-instance_method" title="DropboxScaffoldBuilder#generate (method)">#generate</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Users/GetAccount.html#get_account-instance_method" title="DropboxApi::Endpoints::Users::GetAccount#get_account (method)">#get_account</a></span>
+    <small>DropboxApi::Endpoints::Users::GetAccount</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#get_account-instance_method" title="DropboxApi::Client#get_account (method)">#get_account</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Users/GetAccountBatch.html#get_account_batch-instance_method" title="DropboxApi::Endpoints::Users::GetAccountBatch#get_account_batch (method)">#get_account_batch</a></span>
+    <small>DropboxApi::Endpoints::Users::GetAccountBatch</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#get_account_batch-instance_method" title="DropboxApi::Client#get_account_batch (method)">#get_account_batch</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#get_current_account-instance_method" title="DropboxApi::Client#get_current_account (method)">#get_current_account</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Users/GetCurrentAccount.html#get_current_account-instance_method" title="DropboxApi::Endpoints::Users::GetCurrentAccount#get_current_account (method)">#get_current_account</a></span>
+    <small>DropboxApi::Endpoints::Users::GetCurrentAccount</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/GetMetadata.html#get_metadata-instance_method" title="DropboxApi::Endpoints::Files::GetMetadata#get_metadata (method)">#get_metadata</a></span>
+    <small>DropboxApi::Endpoints::Files::GetMetadata</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#get_metadata-instance_method" title="DropboxApi::Client#get_metadata (method)">#get_metadata</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/GetPreview.html#get_preview-instance_method" title="DropboxApi::Endpoints::Files::GetPreview#get_preview (method)">#get_preview</a></span>
+    <small>DropboxApi::Endpoints::Files::GetPreview</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#get_preview-instance_method" title="DropboxApi::Client#get_preview (method)">#get_preview</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html#get_shared_link_metadata-instance_method" title="DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata#get_shared_link_metadata (method)">#get_shared_link_metadata</a></span>
+    <small>DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#get_shared_link_metadata-instance_method" title="DropboxApi::Client#get_shared_link_metadata (method)">#get_shared_link_metadata</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#get_space_usage-instance_method" title="DropboxApi::Client#get_space_usage (method)">#get_space_usage</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Users/GetSpaceUsage.html#get_space_usage-instance_method" title="DropboxApi::Endpoints::Users::GetSpaceUsage#get_space_usage (method)">#get_space_usage</a></span>
+    <small>DropboxApi::Endpoints::Users::GetSpaceUsage</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#get_temporary_link-instance_method" title="DropboxApi::Client#get_temporary_link (method)">#get_temporary_link</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/GetTemporaryLink.html#get_temporary_link-instance_method" title="DropboxApi::Endpoints::Files::GetTemporaryLink#get_temporary_link (method)">#get_temporary_link</a></span>
+    <small>DropboxApi::Endpoints::Files::GetTemporaryLink</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#get_thumbnail-instance_method" title="DropboxApi::Client#get_thumbnail (method)">#get_thumbnail</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/GetThumbnail.html#get_thumbnail-instance_method" title="DropboxApi::Endpoints::Files::GetThumbnail#get_thumbnail (method)">#get_thumbnail</a></span>
+    <small>DropboxApi::Endpoints::Files::GetThumbnail</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/GetThumbnailBatch.html#get_thumbnail_batch-instance_method" title="DropboxApi::Endpoints::Files::GetThumbnailBatch#get_thumbnail_batch (method)">#get_thumbnail_batch</a></span>
+    <small>DropboxApi::Endpoints::Files::GetThumbnailBatch</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#get_thumbnail_batch-instance_method" title="DropboxApi::Client#get_thumbnail_batch (method)">#get_thumbnail_batch</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SharedFileMembers.html#groups-instance_method" title="DropboxApi::Results::SharedFileMembers#groups (method)">#groups</a></span>
+    <small>DropboxApi::Results::SharedFileMembers</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SharedFolderMembers.html#groups-instance_method" title="DropboxApi::Results::SharedFolderMembers#groups (method)">#groups</a></span>
+    <small>DropboxApi::Results::SharedFolderMembers</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ResultBuilder.html#has_error%3F-instance_method" title="DropboxApi::ResultBuilder#has_error? (method)">#has_error?</a></span>
+    <small>DropboxApi::ResultBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SearchV2Result.html#has_more%3F-instance_method" title="DropboxApi::Results::SearchV2Result#has_more? (method)">#has_more?</a></span>
+    <small>DropboxApi::Results::SearchV2Result</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/ListFolderResult.html#has_more%3F-instance_method" title="DropboxApi::Results::ListFolderResult#has_more? (method)">#has_more?</a></span>
+    <small>DropboxApi::Results::ListFolderResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/ListSharedLinksResult.html#has_more%3F-instance_method" title="DropboxApi::Results::ListSharedLinksResult#has_more? (method)">#has_more?</a></span>
+    <small>DropboxApi::Results::ListSharedLinksResult</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Errors/UploadSessionOffsetError.html#initialize-instance_method" title="DropboxApi::Errors::UploadSessionOffsetError#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Errors::UploadSessionOffsetError</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/MiddleWare/Stack.html#initialize-instance_method" title="DropboxApi::MiddleWare::Stack#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::MiddleWare::Stack</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/MemberActionList.html#initialize-instance_method" title="DropboxApi::Metadata::MemberActionList#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Metadata::MemberActionList</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/BasicAccountBatch.html#initialize-instance_method" title="DropboxApi::Results::BasicAccountBatch#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Results::BasicAccountBatch</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#initialize-instance_method" title="DropboxScaffoldBuilder#initialize (method)">#initialize</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/MemberPermissionList.html#initialize-instance_method" title="DropboxApi::Metadata::MemberPermissionList#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Metadata::MemberPermissionList</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Errors/BasicError.html#initialize-instance_method" title="DropboxApi::Errors::BasicError#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Errors::BasicError</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/WriteMode.html#initialize-instance_method" title="DropboxApi::Metadata::WriteMode#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Metadata::WriteMode</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/SharedLink.html#initialize-instance_method" title="DropboxApi::Metadata::SharedLink#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Metadata::SharedLink</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#initialize-instance_method" title="DropboxApi::Client#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ChunkedUploader.html#initialize-instance_method" title="DropboxApi::ChunkedUploader#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::ChunkedUploader</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Member.html#initialize-instance_method" title="DropboxApi::Metadata::Member#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Metadata::Member</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/AddFileMemberResultList.html#initialize-instance_method" title="DropboxApi::Results::AddFileMemberResultList#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Results::AddFileMemberResultList</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ResultBuilder.html#initialize-instance_method" title="DropboxApi::ResultBuilder#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::ResultBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Field.html#initialize-instance_method" title="DropboxApi::Metadata::Field#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Metadata::Field</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Base.html#initialize-instance_method" title="DropboxApi::Endpoints::Base#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Endpoints::Base</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Metadata::Base</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Authenticator.html#initialize-instance_method" title="DropboxApi::Authenticator#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Authenticator</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/MiddleWare/PathRoot.html#initialize-instance_method" title="DropboxApi::MiddleWare::PathRoot#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::MiddleWare::PathRoot</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/Search/Match.html#initialize-instance_method" title="DropboxApi::Results::Search::Match#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Results::Search::Match</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/FileCategoriesList.html#initialize-instance_method" title="DropboxApi::Metadata::FileCategoriesList#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Metadata::FileCategoriesList</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/FileExtensionsList.html#initialize-instance_method" title="DropboxApi::Metadata::FileExtensionsList#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Metadata::FileExtensionsList</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/Base.html#initialize-instance_method" title="DropboxApi::Results::Base#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::Results::Base</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ConnectionBuilder.html#initialize-instance_method" title="DropboxApi::ConnectionBuilder#initialize (method)">#initialize</a></span>
+    <small>DropboxApi::ConnectionBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SharedFileMembers.html#invitees-instance_method" title="DropboxApi::Results::SharedFileMembers#invitees (method)">#invitees</a></span>
+    <small>DropboxApi::Results::SharedFileMembers</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SharedFolderMembers.html#invitees-instance_method" title="DropboxApi::Results::SharedFolderMembers#invitees (method)">#invitees</a></span>
+    <small>DropboxApi::Results::SharedFolderMembers</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/ListRevisionsResult.html#is_deleted%3F-instance_method" title="DropboxApi::Results::ListRevisionsResult#is_deleted? (method)">#is_deleted?</a></span>
+    <small>DropboxApi::Results::ListRevisionsResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/GetTemporaryLinkResult.html#link-instance_method" title="DropboxApi::Results::GetTemporaryLinkResult#link (method)">#link</a></span>
+    <small>DropboxApi::Results::GetTemporaryLinkResult</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/ListSharedLinksResult.html#links-instance_method" title="DropboxApi::Results::ListSharedLinksResult#links (method)">#links</a></span>
+    <small>DropboxApi::Results::ListSharedLinksResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#list_file_members-instance_method" title="DropboxApi::Client#list_file_members (method)">#list_file_members</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/ListFileMembers.html#list_file_members-instance_method" title="DropboxApi::Endpoints::Sharing::ListFileMembers#list_file_members (method)">#list_file_members</a></span>
+    <small>DropboxApi::Endpoints::Sharing::ListFileMembers</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#list_folder-instance_method" title="DropboxApi::Client#list_folder (method)">#list_folder</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/ListFolder.html#list_folder-instance_method" title="DropboxApi::Endpoints::Files::ListFolder#list_folder (method)">#list_folder</a></span>
+    <small>DropboxApi::Endpoints::Files::ListFolder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/ListFolderContinue.html#list_folder_continue-instance_method" title="DropboxApi::Endpoints::Files::ListFolderContinue#list_folder_continue (method)">#list_folder_continue</a></span>
+    <small>DropboxApi::Endpoints::Files::ListFolderContinue</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#list_folder_continue-instance_method" title="DropboxApi::Client#list_folder_continue (method)">#list_folder_continue</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html#list_folder_get_latest_cursor-instance_method" title="DropboxApi::Endpoints::Files::ListFolderGetLatestCursor#list_folder_get_latest_cursor (method)">#list_folder_get_latest_cursor</a></span>
+    <small>DropboxApi::Endpoints::Files::ListFolderGetLatestCursor</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#list_folder_get_latest_cursor-instance_method" title="DropboxApi::Client#list_folder_get_latest_cursor (method)">#list_folder_get_latest_cursor</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#list_folder_longpoll-instance_method" title="DropboxApi::Client#list_folder_longpoll (method)">#list_folder_longpoll</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/ListFolderLongpoll.html#list_folder_longpoll-instance_method" title="DropboxApi::Endpoints::Files::ListFolderLongpoll#list_folder_longpoll (method)">#list_folder_longpoll</a></span>
+    <small>DropboxApi::Endpoints::Files::ListFolderLongpoll</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#list_folder_members-instance_method" title="DropboxApi::Client#list_folder_members (method)">#list_folder_members</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/ListFolderMembers.html#list_folder_members-instance_method" title="DropboxApi::Endpoints::Sharing::ListFolderMembers#list_folder_members (method)">#list_folder_members</a></span>
+    <small>DropboxApi::Endpoints::Sharing::ListFolderMembers</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#list_revisions-instance_method" title="DropboxApi::Client#list_revisions (method)">#list_revisions</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/ListRevisions.html#list_revisions-instance_method" title="DropboxApi::Endpoints::Files::ListRevisions#list_revisions (method)">#list_revisions</a></span>
+    <small>DropboxApi::Endpoints::Files::ListRevisions</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/ListSharedLinks.html#list_shared_links-instance_method" title="DropboxApi::Endpoints::Sharing::ListSharedLinks#list_shared_links (method)">#list_shared_links</a></span>
+    <small>DropboxApi::Endpoints::Sharing::ListSharedLinks</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#list_shared_links-instance_method" title="DropboxApi::Client#list_shared_links (method)">#list_shared_links</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/Search/Match.html#match_type-instance_method" title="DropboxApi::Results::Search::Match#match_type (method)">#match_type</a></span>
+    <small>DropboxApi::Results::Search::Match</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SearchV2Result.html#matches-instance_method" title="DropboxApi::Results::SearchV2Result#matches (method)">#matches</a></span>
+    <small>DropboxApi::Results::SearchV2Result</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#middleware-instance_method" title="DropboxApi::Client#middleware (method)">#middleware</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ConnectionBuilder.html#middleware-instance_method" title="DropboxApi::ConnectionBuilder#middleware (method)">#middleware</a></span>
+    <small>DropboxApi::ConnectionBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#move-instance_method" title="DropboxApi::Client#move (method)">#move</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/Move.html#move-instance_method" title="DropboxApi::Endpoints::Files::Move#move (method)">#move</a></span>
+    <small>DropboxApi::Endpoints::Files::Move</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ConnectionBuilder.html#namespace_id-instance_method" title="DropboxApi::ConnectionBuilder#namespace_id (method)">#namespace_id</a></span>
+    <small>DropboxApi::ConnectionBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#namespace_id-instance_method" title="DropboxApi::Client#namespace_id (method)">#namespace_id</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/MiddleWare/PathRoot.html#namespace_id-instance_method" title="DropboxApi::MiddleWare::PathRoot#namespace_id (method)">#namespace_id</a></span>
+    <small>DropboxApi::MiddleWare::PathRoot</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#namespace_id=-instance_method" title="DropboxApi::Client#namespace_id= (method)">#namespace_id=</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/MiddleWare/PathRoot.html#namespace_id_header_value-instance_method" title="DropboxApi::MiddleWare::PathRoot#namespace_id_header_value (method)">#namespace_id_header_value</a></span>
+    <small>DropboxApi::MiddleWare::PathRoot</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/ShareFolderLaunch.html#new-class_method" title="DropboxApi::Results::ShareFolderLaunch.new (method)">new</a></span>
+    <small>DropboxApi::Results::ShareFolderLaunch</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/SharedLinkMetadata.html#new-class_method" title="DropboxApi::Metadata::SharedLinkMetadata.new (method)">new</a></span>
+    <small>DropboxApi::Metadata::SharedLinkMetadata</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Tag.html#new-class_method" title="DropboxApi::Metadata::Tag.new (method)">new</a></span>
+    <small>DropboxApi::Metadata::Tag</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SaveUrlJobStatus.html#new-class_method" title="DropboxApi::Results::SaveUrlJobStatus.new (method)">new</a></span>
+    <small>DropboxApi::Results::SaveUrlJobStatus</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/RelocationBatchResult.html#new-class_method" title="DropboxApi::Results::RelocationBatchResult.new (method)">new</a></span>
+    <small>DropboxApi::Results::RelocationBatchResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/DeleteBatchResult.html#new-class_method" title="DropboxApi::Results::DeleteBatchResult.new (method)">new</a></span>
+    <small>DropboxApi::Results::DeleteBatchResult</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/FileMemberAction.html#new-class_method" title="DropboxApi::Metadata::FileMemberAction.new (method)">new</a></span>
+    <small>DropboxApi::Metadata::FileMemberAction</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Resource.html#new-class_method" title="DropboxApi::Metadata::Resource.new (method)">new</a></span>
+    <small>DropboxApi::Metadata::Resource</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/DeleteBatchResultEntry.html#new-class_method" title="DropboxApi::Results::DeleteBatchResultEntry.new (method)">new</a></span>
+    <small>DropboxApi::Results::DeleteBatchResultEntry</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/CopyBatchResult.html#new-class_method" title="DropboxApi::Results::CopyBatchResult.new (method)">new</a></span>
+    <small>DropboxApi::Results::CopyBatchResult</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/MediaMetadata.html#new-class_method" title="DropboxApi::Metadata::MediaMetadata.new (method)">new</a></span>
+    <small>DropboxApi::Metadata::MediaMetadata</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/CreateFolderBatchResult.html#new-class_method" title="DropboxApi::Results::CreateFolderBatchResult.new (method)">new</a></span>
+    <small>DropboxApi::Results::CreateFolderBatchResult</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/RootInfo.html#new-class_method" title="DropboxApi::Metadata::RootInfo.new (method)">new</a></span>
+    <small>DropboxApi::Metadata::RootInfo</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/MediaInfo.html#new-class_method" title="DropboxApi::Metadata::MediaInfo.new (method)">new</a></span>
+    <small>DropboxApi::Metadata::MediaInfo</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/CreateFolderBatchResultEntry.html#new-class_method" title="DropboxApi::Results::CreateFolderBatchResultEntry.new (method)">new</a></span>
+    <small>DropboxApi::Results::CreateFolderBatchResultEntry</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/RelocationBatchResultEntry.html#new-class_method" title="DropboxApi::Results::RelocationBatchResultEntry.new (method)">new</a></span>
+    <small>DropboxApi::Results::RelocationBatchResultEntry</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/ThumbnailBatchResultEntry.html#new-class_method" title="DropboxApi::Metadata::ThumbnailBatchResultEntry.new (method)">new</a></span>
+    <small>DropboxApi::Metadata::ThumbnailBatchResultEntry</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/UploadSessionCursor.html#offset=-instance_method" title="DropboxApi::Metadata::UploadSessionCursor#offset= (method)">#offset=</a></span>
+    <small>DropboxApi::Metadata::UploadSessionCursor</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#path_prefix-instance_method" title="DropboxScaffoldBuilder#path_prefix (method)">#path_prefix</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/ContentDownload.html#perform_request-instance_method" title="DropboxApi::Endpoints::ContentDownload#perform_request (method)">#perform_request</a></span>
+    <small>DropboxApi::Endpoints::ContentDownload</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/ContentUpload.html#perform_request-instance_method" title="DropboxApi::Endpoints::ContentUpload#perform_request (method)">#perform_request</a></span>
+    <small>DropboxApi::Endpoints::ContentUpload</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/PermanentlyDelete.html#permanently_delete-instance_method" title="DropboxApi::Endpoints::Files::PermanentlyDelete#permanently_delete (method)">#permanently_delete</a></span>
+    <small>DropboxApi::Endpoints::Files::PermanentlyDelete</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#permanently_delete-instance_method" title="DropboxApi::Client#permanently_delete (method)">#permanently_delete</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#prefix_for-class_method" title="DropboxScaffoldBuilder.prefix_for (method)">prefix_for</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/MiddleWare/Stack.html#prepend-instance_method" title="DropboxApi::MiddleWare::Stack#prepend (method)">#prepend</a></span>
+    <small>DropboxApi::MiddleWare::Stack</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ConnectionBuilder.html#refresh_access_token-instance_method" title="DropboxApi::ConnectionBuilder#refresh_access_token (method)">#refresh_access_token</a></span>
+    <small>DropboxApi::ConnectionBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#regenerate-class_method" title="DropboxScaffoldBuilder.regenerate (method)">regenerate</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxScaffoldBuilder.html#regenerate_all-class_method" title="DropboxScaffoldBuilder.regenerate_all (method)">regenerate_all</a></span>
+    <small>DropboxScaffoldBuilder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span>
+    <small>DropboxApi::Endpoints::Rpc</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SaveCopyReferenceResult.html#resource-instance_method" title="DropboxApi::Results::SaveCopyReferenceResult#resource (method)">#resource</a></span>
+    <small>DropboxApi::Results::SaveCopyReferenceResult</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/Search/Match.html#resource-instance_method" title="DropboxApi::Results::Search::Match#resource (method)">#resource</a></span>
+    <small>DropboxApi::Results::Search::Match</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/SearchMatchV2.html#resource-instance_method" title="DropboxApi::Metadata::SearchMatchV2#resource (method)">#resource</a></span>
+    <small>DropboxApi::Metadata::SearchMatchV2</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/GetCopyReferenceResult.html#resource-instance_method" title="DropboxApi::Results::GetCopyReferenceResult#resource (method)">#resource</a></span>
+    <small>DropboxApi::Results::GetCopyReferenceResult</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/Restore.html#restore-instance_method" title="DropboxApi::Endpoints::Files::Restore#restore (method)">#restore</a></span>
+    <small>DropboxApi::Endpoints::Files::Restore</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#restore-instance_method" title="DropboxApi::Client#restore (method)">#restore</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Errors/TooManyRequestsError.html#retry_after-instance_method" title="DropboxApi::Errors::TooManyRequestsError#retry_after (method)">#retry_after</a></span>
+    <small>DropboxApi::Errors::TooManyRequestsError</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/RevokeSharedLink.html#revoke_shared_link-instance_method" title="DropboxApi::Endpoints::Sharing::RevokeSharedLink#revoke_shared_link (method)">#revoke_shared_link</a></span>
+    <small>DropboxApi::Endpoints::Sharing::RevokeSharedLink</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#revoke_shared_link-instance_method" title="DropboxApi::Client#revoke_shared_link (method)">#revoke_shared_link</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#save_url-instance_method" title="DropboxApi::Client#save_url (method)">#save_url</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/SaveUrl.html#save_url-instance_method" title="DropboxApi::Endpoints::Files::SaveUrl#save_url (method)">#save_url</a></span>
+    <small>DropboxApi::Endpoints::Files::SaveUrl</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#save_url_check_job_status-instance_method" title="DropboxApi::Client#save_url_check_job_status (method)">#save_url_check_job_status</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html#save_url_check_job_status-instance_method" title="DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus#save_url_check_job_status (method)">#save_url_check_job_status</a></span>
+    <small>DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/Search.html#search-instance_method" title="DropboxApi::Endpoints::Files::Search#search (method)">#search</a></span>
+    <small>DropboxApi::Endpoints::Files::Search</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#search-instance_method" title="DropboxApi::Client#search (method)">#search</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/SearchContinue.html#search_continue-instance_method" title="DropboxApi::Endpoints::Files::SearchContinue#search_continue (method)">#search_continue</a></span>
+    <small>DropboxApi::Endpoints::Files::SearchContinue</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#search_continue-instance_method" title="DropboxApi::Client#search_continue (method)">#search_continue</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Base.html#serialized_field-instance_method" title="DropboxApi::Metadata::Base#serialized_field (method)">#serialized_field</a></span>
+    <small>DropboxApi::Metadata::Base</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/UploadSessionStart.html#session_id-instance_method" title="DropboxApi::Results::UploadSessionStart#session_id (method)">#session_id</a></span>
+    <small>DropboxApi::Results::UploadSessionStart</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#share_folder-instance_method" title="DropboxApi::Client#share_folder (method)">#share_folder</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/ShareFolder.html#share_folder-instance_method" title="DropboxApi::Endpoints::Sharing::ShareFolder#share_folder (method)">#share_folder</a></span>
+    <small>DropboxApi::Endpoints::Sharing::ShareFolder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Errors/AlreadySharedError.html#shared_folder-instance_method" title="DropboxApi::Errors::AlreadySharedError#shared_folder (method)">#shared_folder</a></span>
+    <small>DropboxApi::Errors::AlreadySharedError</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ChunkedUploader.html#start-instance_method" title="DropboxApi::ChunkedUploader#start (method)">#start</a></span>
+    <small>DropboxApi::ChunkedUploader</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ResultBuilder.html#success%3F-instance_method" title="DropboxApi::ResultBuilder#success? (method)">#success?</a></span>
+    <small>DropboxApi::ResultBuilder</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Folder.html#to_hash-instance_method" title="DropboxApi::Metadata::Folder#to_hash (method)">#to_hash</a></span>
+    <small>DropboxApi::Metadata::Folder</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/SharedLink.html#to_hash-instance_method" title="DropboxApi::Metadata::SharedLink#to_hash (method)">#to_hash</a></span>
+    <small>DropboxApi::Metadata::SharedLink</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/NamespaceId.html#to_hash-instance_method" title="DropboxApi::Metadata::NamespaceId#to_hash (method)">#to_hash</a></span>
+    <small>DropboxApi::Metadata::NamespaceId</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/WriteMode.html#to_hash-instance_method" title="DropboxApi::Metadata::WriteMode#to_hash (method)">#to_hash</a></span>
+    <small>DropboxApi::Metadata::WriteMode</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Base.html#to_hash-instance_method" title="DropboxApi::Metadata::Base#to_hash (method)">#to_hash</a></span>
+    <small>DropboxApi::Metadata::Base</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/File.html#to_hash-instance_method" title="DropboxApi::Metadata::File#to_hash (method)">#to_hash</a></span>
+    <small>DropboxApi::Metadata::File</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Member.html#to_hash-instance_method" title="DropboxApi::Metadata::Member#to_hash (method)">#to_hash</a></span>
+    <small>DropboxApi::Metadata::Member</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Auth/TokenRevoke.html#token_revoke-instance_method" title="DropboxApi::Endpoints::Auth::TokenRevoke#token_revoke (method)">#token_revoke</a></span>
+    <small>DropboxApi::Endpoints::Auth::TokenRevoke</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#token_revoke-instance_method" title="DropboxApi::Client#token_revoke (method)">#token_revoke</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#unshare_file-instance_method" title="DropboxApi::Client#unshare_file (method)">#unshare_file</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Sharing/UnshareFile.html#unshare_file-instance_method" title="DropboxApi::Endpoints::Sharing::UnshareFile#unshare_file (method)">#unshare_file</a></span>
+    <small>DropboxApi::Endpoints::Sharing::UnshareFile</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#upload-instance_method" title="DropboxApi::Client#upload (method)">#upload</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/ChunkedUploader.html#upload-instance_method" title="DropboxApi::ChunkedUploader#upload (method)">#upload</a></span>
+    <small>DropboxApi::ChunkedUploader</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/Upload.html#upload-instance_method" title="DropboxApi::Endpoints::Files::Upload#upload (method)">#upload</a></span>
+    <small>DropboxApi::Endpoints::Files::Upload</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#upload_by_chunks-instance_method" title="DropboxApi::Client#upload_by_chunks (method)">#upload_by_chunks</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/UploadSessionAppendV2.html#upload_session_append_v2-instance_method" title="DropboxApi::Endpoints::Files::UploadSessionAppendV2#upload_session_append_v2 (method)">#upload_session_append_v2</a></span>
+    <small>DropboxApi::Endpoints::Files::UploadSessionAppendV2</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#upload_session_append_v2-instance_method" title="DropboxApi::Client#upload_session_append_v2 (method)">#upload_session_append_v2</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#upload_session_finish-instance_method" title="DropboxApi::Client#upload_session_finish (method)">#upload_session_finish</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/UploadSessionFinish.html#upload_session_finish-instance_method" title="DropboxApi::Endpoints::Files::UploadSessionFinish#upload_session_finish (method)">#upload_session_finish</a></span>
+    <small>DropboxApi::Endpoints::Files::UploadSessionFinish</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Endpoints/Files/UploadSessionStart.html#upload_session_start-instance_method" title="DropboxApi::Endpoints::Files::UploadSessionStart#upload_session_start (method)">#upload_session_start</a></span>
+    <small>DropboxApi::Endpoints::Files::UploadSessionStart</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Client.html#upload_session_start-instance_method" title="DropboxApi::Client#upload_session_start (method)">#upload_session_start</a></span>
+    <small>DropboxApi::Client</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SharedFileMembers.html#users-instance_method" title="DropboxApi::Results::SharedFileMembers#users (method)">#users</a></span>
+    <small>DropboxApi::Results::SharedFileMembers</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Results/SharedFolderMembers.html#users-instance_method" title="DropboxApi::Results::SharedFolderMembers#users (method)">#users</a></span>
+    <small>DropboxApi::Results::SharedFolderMembers</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/SearchOrderBy.html#valid_values-class_method" title="DropboxApi::Metadata::SearchOrderBy.valid_values (method)">valid_values</a></span>
+    <small>DropboxApi::Metadata::SearchOrderBy</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/FileCategory.html#valid_values-class_method" title="DropboxApi::Metadata::FileCategory.valid_values (method)">valid_values</a></span>
+    <small>DropboxApi::Metadata::FileCategory</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/FileStatus.html#valid_values-class_method" title="DropboxApi::Metadata::FileStatus.valid_values (method)">valid_values</a></span>
+    <small>DropboxApi::Metadata::FileStatus</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/MemberAction.html#valid_values-class_method" title="DropboxApi::Metadata::MemberAction.valid_values (method)">valid_values</a></span>
+    <small>DropboxApi::Metadata::MemberAction</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/SearchMatchTypeV2.html#valid_values-class_method" title="DropboxApi::Metadata::SearchMatchTypeV2.valid_values (method)">valid_values</a></span>
+    <small>DropboxApi::Metadata::SearchMatchTypeV2</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/AccessLevel.html#valid_values-class_method" title="DropboxApi::Metadata::AccessLevel.valid_values (method)">valid_values</a></span>
+    <small>DropboxApi::Metadata::AccessLevel</small>
+  </div>
+</li>
+
+<li class="even ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/Metadata/Tag.html#validate-class_method" title="DropboxApi::Metadata::Tag.validate (method)">validate</a></span>
+    <small>DropboxApi::Metadata::Tag</small>
+  </div>
+</li>
+
+<li class="odd ">
+  <div class="item">
+    <span class='object_link'><a href="DropboxApi/OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span>
+    <small>DropboxApi::OptionsValidator</small>
+  </div>
+</li>
+
+    </ul>
+  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/docs/top-level-namespace_html.html b/doc/docs/top-level-namespace_html.html new file mode 100644 index 00000000..5acf3f0a --- /dev/null +++ b/doc/docs/top-level-namespace_html.html @@ -0,0 +1,792 @@ + + + + + + +top-level-namespace.html - RDoc Documentation + + + + + + + + + + + + + + +
+ +

<!DOCTYPE html> <html>

+ +
<head>
+  <meta charset="utf-8">
+ +

<meta name=“viewport” content=“width=device-width, +initial-scale=1.0”> <title>

+ +
Top Level Namespace
+
+  &mdash; Documentation by YARD 0.9.26
+ +

</title>

+ +
<link rel="stylesheet" href="css/style.css" type="text/css" />
+
+<link rel="stylesheet" href="css/common.css" type="text/css" />
+ +

<script type=“text/javascript”>

+ +
pathId = "";
+relpath = '';
+
+ +

</script>

+ +
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+</head>
+<body>
+  <div class="nav_wrap">
+    <iframe id="nav" src="class_list.html?1"></iframe>
+    <div id="resizer"></div>
+  </div>
+
+  <div id="main" tabindex="-1">
+    <div id="header">
+      <div id="menu">
+
+  <a href="_index.html">Index</a> &raquo;
+
+  <span class="title">Top Level Namespace</span>
+ +

</div>

+ +
    <div id="search">
+
+<a class="full_list_link" id="class_list_link"
+    href="class_list.html">
+
+    <svg width="24" height="24">
+      <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+      <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+    </svg>
+</a>
+ +

</div>

+ +
  <div class="clear"></div>
+</div>
+
+<div id="content"><h1>Top Level Namespace
+ +

</h1> <div class=“box_info”>

+ +

</div>

+ +

<h2>Defined Under Namespace</h2> <p class=“children”>

+ +
<strong class="modules">Modules:</strong> <span class='object_link'><a href="DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span>
+
+<strong class="classes">Classes:</strong> <span class='object_link'><a href="DropboxScaffoldBuilder.html" title="DropboxScaffoldBuilder (class)">DropboxScaffoldBuilder</a></span>
+ +

</p>

+ +

</div>

+ +
    <div id="footer">
+Generated on Wed Sep 29 23:44:24 2021 by
+<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+0.9.26 (ruby-2.6.5).
+ +

</div>

+ +
  </div>
+</body>
+ +

</html>

+
+ + + + + diff --git a/doc/dropbox_api_gemspec.html b/doc/dropbox_api_gemspec.html new file mode 100644 index 00000000..2a4abc9d --- /dev/null +++ b/doc/dropbox_api_gemspec.html @@ -0,0 +1,726 @@ + + + + + + +dropbox_api.gemspec - RDoc Documentation + + + + + + + + + + + + + + +
+ +

lib = File.expand_path('../lib', __FILE__) $LOAD_PATH.unshift(lib) +unless $LOAD_PATH.include?(lib) require 'dropbox_api/version'

+ +

Gem::Specification.new do |spec|

+ +
spec.name          = 'dropbox_api'
+spec.version       = DropboxApi::VERSION
+spec.authors       = ['Jesús Burgos']
+spec.email         = ['jburmac@gmail.com']
+
+spec.summary       = 'Library for communicating with Dropbox API v2'
+spec.homepage      = 'https://github.com/Jesus/dropbox_api'
+spec.license       = 'MIT'
+
+spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+spec.require_paths = ['lib']
+
+spec.required_ruby_version = '>= 2.3'
+
+spec.add_dependency 'faraday', '< 3.0'
+spec.add_dependency 'oauth2', '~> 1.1'
+
+ +

end

+
+ + + + + diff --git a/doc/fonts/Lato-Light.ttf b/doc/fonts/Lato-Light.ttf new file mode 100644 index 00000000..b49dd437 Binary files /dev/null and b/doc/fonts/Lato-Light.ttf differ diff --git a/doc/fonts/Lato-LightItalic.ttf b/doc/fonts/Lato-LightItalic.ttf new file mode 100644 index 00000000..7959fef0 Binary files /dev/null and b/doc/fonts/Lato-LightItalic.ttf differ diff --git a/doc/fonts/Lato-Regular.ttf b/doc/fonts/Lato-Regular.ttf new file mode 100644 index 00000000..839cd589 Binary files /dev/null and b/doc/fonts/Lato-Regular.ttf differ diff --git a/doc/fonts/Lato-RegularItalic.ttf b/doc/fonts/Lato-RegularItalic.ttf new file mode 100644 index 00000000..bababa09 Binary files /dev/null and b/doc/fonts/Lato-RegularItalic.ttf differ diff --git a/doc/fonts/SourceCodePro-Bold.ttf b/doc/fonts/SourceCodePro-Bold.ttf new file mode 100644 index 00000000..61e3090c Binary files /dev/null and b/doc/fonts/SourceCodePro-Bold.ttf differ diff --git a/doc/fonts/SourceCodePro-Regular.ttf b/doc/fonts/SourceCodePro-Regular.ttf new file mode 100644 index 00000000..85686d96 Binary files /dev/null and b/doc/fonts/SourceCodePro-Regular.ttf differ diff --git a/doc/images/add.png b/doc/images/add.png new file mode 100644 index 00000000..6332fefe Binary files /dev/null and b/doc/images/add.png differ diff --git a/doc/images/arrow_up.png b/doc/images/arrow_up.png new file mode 100644 index 00000000..1ebb1932 Binary files /dev/null and b/doc/images/arrow_up.png differ diff --git a/doc/images/brick.png b/doc/images/brick.png new file mode 100644 index 00000000..7851cf34 Binary files /dev/null and b/doc/images/brick.png differ diff --git a/doc/images/brick_link.png b/doc/images/brick_link.png new file mode 100644 index 00000000..9ebf013a Binary files /dev/null and b/doc/images/brick_link.png differ diff --git a/doc/images/bug.png b/doc/images/bug.png new file mode 100644 index 00000000..2d5fb90e Binary files /dev/null and b/doc/images/bug.png differ diff --git a/doc/images/bullet_black.png b/doc/images/bullet_black.png new file mode 100644 index 00000000..57619706 Binary files /dev/null and b/doc/images/bullet_black.png differ diff --git a/doc/images/bullet_toggle_minus.png b/doc/images/bullet_toggle_minus.png new file mode 100644 index 00000000..b47ce55f Binary files /dev/null and b/doc/images/bullet_toggle_minus.png differ diff --git a/doc/images/bullet_toggle_plus.png b/doc/images/bullet_toggle_plus.png new file mode 100644 index 00000000..9ab4a896 Binary files /dev/null and b/doc/images/bullet_toggle_plus.png differ diff --git a/doc/images/date.png b/doc/images/date.png new file mode 100644 index 00000000..783c8335 Binary files /dev/null and b/doc/images/date.png differ diff --git a/doc/images/delete.png b/doc/images/delete.png new file mode 100644 index 00000000..08f24936 Binary files /dev/null and b/doc/images/delete.png differ diff --git a/doc/images/find.png b/doc/images/find.png new file mode 100644 index 00000000..15474796 Binary files /dev/null and b/doc/images/find.png differ diff --git a/doc/images/loadingAnimation.gif b/doc/images/loadingAnimation.gif new file mode 100644 index 00000000..82290f48 Binary files /dev/null and b/doc/images/loadingAnimation.gif differ diff --git a/doc/images/macFFBgHack.png b/doc/images/macFFBgHack.png new file mode 100644 index 00000000..c6473b32 Binary files /dev/null and b/doc/images/macFFBgHack.png differ diff --git a/doc/images/package.png b/doc/images/package.png new file mode 100644 index 00000000..da3c2a2d Binary files /dev/null and b/doc/images/package.png differ diff --git a/doc/images/page_green.png b/doc/images/page_green.png new file mode 100644 index 00000000..de8e003f Binary files /dev/null and b/doc/images/page_green.png differ diff --git a/doc/images/page_white_text.png b/doc/images/page_white_text.png new file mode 100644 index 00000000..813f712f Binary files /dev/null and b/doc/images/page_white_text.png differ diff --git a/doc/images/page_white_width.png b/doc/images/page_white_width.png new file mode 100644 index 00000000..1eb88094 Binary files /dev/null and b/doc/images/page_white_width.png differ diff --git a/doc/images/plugin.png b/doc/images/plugin.png new file mode 100644 index 00000000..6187b15a Binary files /dev/null and b/doc/images/plugin.png differ diff --git a/doc/images/ruby.png b/doc/images/ruby.png new file mode 100644 index 00000000..f763a168 Binary files /dev/null and b/doc/images/ruby.png differ diff --git a/doc/images/tag_blue.png b/doc/images/tag_blue.png new file mode 100644 index 00000000..3f02b5f8 Binary files /dev/null and b/doc/images/tag_blue.png differ diff --git a/doc/images/tag_green.png b/doc/images/tag_green.png new file mode 100644 index 00000000..83ec984b Binary files /dev/null and b/doc/images/tag_green.png differ diff --git a/doc/images/transparent.png b/doc/images/transparent.png new file mode 100644 index 00000000..d665e179 Binary files /dev/null and b/doc/images/transparent.png differ diff --git a/doc/images/wrench.png b/doc/images/wrench.png new file mode 100644 index 00000000..5c8213fe Binary files /dev/null and b/doc/images/wrench.png differ diff --git a/doc/images/wrench_orange.png b/doc/images/wrench_orange.png new file mode 100644 index 00000000..565a9330 Binary files /dev/null and b/doc/images/wrench_orange.png differ diff --git a/doc/images/zoom.png b/doc/images/zoom.png new file mode 100644 index 00000000..908612e3 Binary files /dev/null and b/doc/images/zoom.png differ diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 00000000..03300725 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,1300 @@ + + + + + + +RDoc Documentation + + + + + + + + + + + + + + +
+

This is the API documentation for RDoc Documentation. +

+ + + + + diff --git a/doc/js/darkfish.js b/doc/js/darkfish.js new file mode 100644 index 00000000..38f877ed --- /dev/null +++ b/doc/js/darkfish.js @@ -0,0 +1,161 @@ +/** + * + * Darkfish Page Functions + * $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $ + * + * Author: Michael Granger + * + */ + +/* Provide console simulation for firebug-less environments */ +if (!("console" in window) || !("firebug" in console)) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml", + "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"]; + + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +}; + + +/** + * Unwrap the first element that matches the given @expr@ from the targets and return them. + */ +$.fn.unwrap = function( expr ) { + return this.each( function() { + $(this).parents( expr ).eq( 0 ).after( this ).remove(); + }); +}; + + +function showSource( e ) { + var target = e.target; + var codeSections = $(target). + parents('.method-detail'). + find('.method-source-code'); + + $(target). + parents('.method-detail'). + find('.method-source-code'). + slideToggle(); +}; + +function hookSourceViews() { + $('.method-heading').click( showSource ); +}; + +function hookSearch() { + var input = $('#search-field').eq(0); + var result = $('#search-results').eq(0); + $(result).show(); + + var search_section = $('#search-section').get(0); + $(search_section).show(); + + var search = new Search(search_data, input, result); + + search.renderItem = function(result) { + var li = document.createElement('li'); + var html = ''; + + // TODO add relative path to + + + + + + + + + + + + +
+ +

@title Rails setup

+ +

Standard OAuth 2 flow set up

+ +

This document describes how to implement the OAuth2 flow in a Rails +application, the process is represented in the following diagram:

+ +

+ +

Source: www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web

+ +

1. Set up some new routes

+ +

You'll have to create a couple of new routes:

+ +
get 'dropbox/auth' => 'dropbox#auth'
+get 'dropbox/auth_callback' => 'dropbox#auth_callback'
+
+ +

We'll use dropbox/auth to perform the step 2 in the +diagram, i.e. this route will redirect to Dropbox.

+ +

The other route, dropbox/auth_callback, will process the +authentication token that we'll receive from Dropbox. Steps 4 & 5.

+ +

2. Set up a Dropbox controller

+ +
class DropboxController < ApplicationController
+  # Example call:
+  # GET /dropbox/auth
+  def auth
+    url = authenticator.authorize_url :redirect_uri => redirect_uri
+
+    redirect_to url
+  end
+
+  # Example call:
+  # GET /dropbox/auth_callback?code=VofXAX8DO1sAAAAAAAACUKBwkDZyMg1zKT0f_FNONeA
+  def auth_callback
+    auth_bearer = authenticator.get_token(params[:code],
+                                          :redirect_uri => redirect_uri)
+    token = auth_bearer.token # This line is step 5 in the diagram.
+
+    # At this stage you may want to persist the reusable token we've acquired.
+    # Remember that it's bound to the Dropbox account of your user.
+
+    # If you persist this token, you can use it in subsequent requests or
+    # background jobs to perform calls to Dropbox API such as the following.
+    folders = DropboxApi::Client.new(token).list_folder "/"
+  end
+
+  private
+
+  def authenticator
+    client_id = "az8ykn83kecoodq"
+    client_secret = "ozp1pxo8e563fc5"
+
+    DropboxApi::Authenticator.new(client_id, client_secret)
+  end
+
+  def redirect_uri
+    dropbox_auth_callback_url # => http://localhost:3000/dropbox/auth_callback
+  end
+end
+
+ +

3. Set up redirect URI in your Dropbox app settings

+ +

In the previous code, you probably noticed that we're providing a +redirect_uri parameter. This is where the user will be +redirected to after accepting our application.

+ +

However, Dropbox will only redirect to a set of whitelisted URIs, so +you'll need to add yours to the list. That's very easy:

+
  1. +

    Log in to your Dropbox developer account at www.dropbox.com/developers.

    +
  2. +

    On the menu, click on “My Apps”. Then click on your application to edit its +settings.

    +
  3. +

    On the OAuth 2 section, add the redirect URI that maps to the +auth_callback method that we've implemented above. For +example, www.yourapp.com/dropbox/oauth_callback.

    +
+
+ + + + + diff --git a/doc/spec/fixtures/file_txt.html b/doc/spec/fixtures/file_txt.html new file mode 100644 index 00000000..ea20d408 --- /dev/null +++ b/doc/spec/fixtures/file_txt.html @@ -0,0 +1,702 @@ + + + + + + +file - RDoc Documentation + + + + + + + + + + + + + + +
+ +

Test data

+
+ + + + + diff --git a/doc/table_of_contents.html b/doc/table_of_contents.html new file mode 100644 index 00000000..c81f2ad6 --- /dev/null +++ b/doc/table_of_contents.html @@ -0,0 +1,2762 @@ + + + + + + +Table of Contents - RDoc Documentation + + + + + + + + + + + + +
+

Table of Contents - RDoc Documentation

+ +

Pages

+ + +

Classes and Modules

+ + +

Methods

+
    + +
  • + ::add_endpoint + — + DropboxApi::Endpoints::Base + +
  • + ::add_endpoint + — + DropboxApi::Client + +
  • + ::build + — + DropboxApi::Errors::BasicError + +
  • + ::build + — + DropboxApi::Errors::TooManyRequestsError + +
  • + ::build_from_options + — + DropboxApi::Metadata::CommitInfo + +
  • + ::build_from_string + — + DropboxApi::Metadata::AddMember + +
  • + ::field + — + DropboxApi::Metadata::Base + +
  • + ::find_subtype + — + DropboxApi::Errors::BasicError + +
  • + ::fixtures_path + — + DropboxScaffoldBuilder + +
  • + ::new + — + DropboxApi::MiddleWare::Stack + +
  • + ::new + — + DropboxApi::ChunkedUploader + +
  • + ::new + — + DropboxApi::Client + +
  • + ::new + — + DropboxApi::ConnectionBuilder + +
  • + ::new + — + DropboxApi::Endpoints::Base + +
  • + ::new + — + DropboxApi::Errors::BasicError + +
  • + ::new + — + DropboxApi::Errors::UploadSessionOffsetError + +
  • + ::new + — + DropboxApi::Metadata::Base + +
  • + ::new + — + DropboxScaffoldBuilder + +
  • + ::new + — + DropboxApi::Metadata::Field + +
  • + ::new + — + DropboxApi::Metadata::FileCategoriesList + +
  • + ::new + — + DropboxApi::Metadata::FileExtensionsList + +
  • + ::new + — + DropboxApi::Metadata::FileMemberAction + +
  • + ::new + — + DropboxApi::Metadata::MediaInfo + +
  • + ::new + — + DropboxApi::Metadata::MediaMetadata + +
  • + ::new + — + DropboxApi::Metadata::Member + +
  • + ::new + — + DropboxApi::Metadata::MemberActionList + +
  • + ::new + — + DropboxApi::Metadata::MemberPermissionList + +
  • + ::new + — + DropboxApi::Metadata::Resource + +
  • + ::new + — + DropboxApi::Metadata::RootInfo + +
  • + ::new + — + DropboxApi::Metadata::SharedLink + +
  • + ::new + — + DropboxApi::Results::ShareFolderLaunch + +
  • + ::new + — + DropboxApi::Metadata::SharedLinkMetadata + +
  • + ::new + — + DropboxApi::Metadata::Tag + +
  • + ::new + — + DropboxApi::Metadata::ThumbnailBatchResultEntry + +
  • + ::new + — + DropboxApi::Metadata::WriteMode + +
  • + ::new + — + DropboxApi::Results::Search::Match + +
  • + ::new + — + DropboxApi::MiddleWare::PathRoot + +
  • + ::new + — + DropboxApi::Results::SaveUrlJobStatus + +
  • + ::new + — + DropboxApi::Results::RelocationBatchResultEntry + +
  • + ::new + — + DropboxApi::ResultBuilder + +
  • + ::new + — + DropboxApi::Results::RelocationBatchResult + +
  • + ::new + — + DropboxApi::Results::AddFileMemberResultList + +
  • + ::new + — + DropboxApi::Results::Base + +
  • + ::new + — + DropboxApi::Results::BasicAccountBatch + +
  • + ::new + — + DropboxApi::Results::CopyBatchResult + +
  • + ::new + — + DropboxApi::Results::CreateFolderBatchResult + +
  • + ::new + — + DropboxApi::Results::CreateFolderBatchResultEntry + +
  • + ::new + — + DropboxApi::Results::DeleteBatchResult + +
  • + ::new + — + DropboxApi::Results::DeleteBatchResultEntry + +
  • + ::new + — + DropboxApi::Authenticator + +
  • + ::prefix_for + — + DropboxScaffoldBuilder + +
  • + ::regenerate + — + DropboxScaffoldBuilder + +
  • + ::regenerate_all + — + DropboxScaffoldBuilder + +
  • + ::valid_values + — + DropboxApi::Metadata::SearchOrderBy + +
  • + ::valid_values + — + DropboxApi::Metadata::MemberAction + +
  • + ::valid_values + — + DropboxApi::Metadata::SearchMatchTypeV2 + +
  • + ::valid_values + — + DropboxApi::Metadata::FileStatus + +
  • + ::valid_values + — + DropboxApi::Metadata::FileCategory + +
  • + ::valid_values + — + DropboxApi::Metadata::AccessLevel + +
  • + ::validate + — + DropboxApi::Metadata::Tag + +
  • + #adapter= + — + DropboxApi::MiddleWare::Stack + +
  • + #append + — + DropboxApi::MiddleWare::Stack + +
  • + #apply + — + DropboxApi::MiddleWare::Stack + +
  • + #async_job_id + — + DropboxApi::Results::SaveUrlResult + +
  • + #backoff + — + DropboxApi::Results::ListFolderLongpollResult + +
  • + #build + — + DropboxApi::ConnectionBuilder + +
  • + #build + — + DropboxApi::ResultBuilder + +
  • + #build_connection + — + DropboxApi::Endpoints::RpcContent + +
  • + #build_connection + — + DropboxApi::Endpoints::RpcNotify + +
  • + #build_connection + — + DropboxApi::Endpoints::ContentDownload + +
  • + #build_connection + — + DropboxApi::Endpoints::ContentUpload + +
  • + #build_connection + — + DropboxApi::Endpoints::Rpc + +
  • + #build_copy_batch + — + DropboxScaffoldBuilder + +
  • + #build_create_file_request + — + DropboxScaffoldBuilder + +
  • + #build_delete + — + DropboxScaffoldBuilder + +
  • + #build_entries_params + — + DropboxApi::Endpoints::Files::GetThumbnailBatch + +
  • + #build_error + — + DropboxApi::ResultBuilder + +
  • + #build_file_hash + — + Object + +
  • + #build_get_metadata + — + DropboxScaffoldBuilder + +
  • + #build_get_shared_link_metadata + — + DropboxScaffoldBuilder + +
  • + #build_get_thumbnail_batch + — + DropboxScaffoldBuilder + +
  • + #build_list_folder + — + DropboxScaffoldBuilder + +
  • + #build_list_folder_longpoll + — + DropboxScaffoldBuilder + +
  • + #build_request + — + DropboxApi::Endpoints::ContentUpload + +
  • + #build_request + — + DropboxApi::Endpoints::ContentDownload + +
  • + #build_request + — + DropboxApi::Endpoints::Rpc + +
  • + #build_search + — + DropboxScaffoldBuilder + +
  • + #build_upload + — + DropboxScaffoldBuilder + +
  • + #build_upload_by_chunks + — + DropboxScaffoldBuilder + +
  • + #call + — + DropboxApi::MiddleWare::PathRoot + +
  • + #call + — + DropboxApi::MiddleWare::DecodeResult + +
  • + #can_refresh_access_token? + — + DropboxApi::ConnectionBuilder + +
  • + #cast + — + DropboxApi::Metadata::Field + +
  • + #changes + — + DropboxApi::Results::ListFolderLongpollResult + +
  • + #check_validity + — + DropboxApi::Metadata::SharedLink + +
  • + #check_validity + — + DropboxApi::Metadata::WriteMode + +
  • + #client + — + DropboxScaffoldBuilder + +
  • + #clobber + — + DropboxScaffoldBuilder + +
  • + #copy_reference + — + DropboxApi::Results::GetCopyReferenceResult + +
  • + #cursor + — + DropboxApi::Results::ListSharedLinksResult + +
  • + #cursor + — + DropboxApi::Results::SearchV2Result + +
  • + #cursor + — + DropboxApi::Results::SharedFileMembers + +
  • + #cursor + — + DropboxApi::Results::ListFolderGetLatestCursorResult + +
  • + #cursor + — + DropboxApi::Results::SharedFolderMembers + +
  • + #cursor + — + DropboxApi::Results::ListFolderResult + +
  • + #decode + — + DropboxApi::MiddleWare::DecodeResult + +
  • + #entries + — + DropboxApi::Results::ListFolderResult + +
  • + #entries + — + DropboxApi::Results::ListRevisionsResult + +
  • + #entries + — + DropboxApi::Results::GetThumbnailBatchResult + +
  • + #error + — + DropboxApi::ResultBuilder + +
  • + #error_summary + — + DropboxApi::ResultBuilder + +
  • + #expires + — + DropboxApi::Results::GetCopyReferenceResult + +
  • + #file + — + DropboxApi::Results::GetTemporaryLinkResult + +
  • + #finish + — + DropboxApi::ChunkedUploader + +
  • + #force_cast + — + DropboxApi::Metadata::Field + +
  • + #generate + — + DropboxScaffoldBuilder + +
  • + #groups + — + DropboxApi::Results::SharedFileMembers + +
  • + #groups + — + DropboxApi::Results::SharedFolderMembers + +
  • + #has_error? + — + DropboxApi::ResultBuilder + +
  • + #has_more? + — + DropboxApi::Results::ListSharedLinksResult + +
  • + #has_more? + — + DropboxApi::Results::SearchV2Result + +
  • + #has_more? + — + DropboxApi::Results::ListFolderResult + +
  • + #init + — + Object + +
  • + #invitees + — + DropboxApi::Results::SharedFolderMembers + +
  • + #invitees + — + DropboxApi::Results::SharedFileMembers + +
  • + #is_deleted? + — + DropboxApi::Results::ListRevisionsResult + +
  • + #link + — + DropboxApi::Results::GetTemporaryLinkResult + +
  • + #links + — + DropboxApi::Results::ListSharedLinksResult + +
  • + #match_type + — + DropboxApi::Results::Search::Match + +
  • + #matches + — + DropboxApi::Results::SearchV2Result + +
  • + #middleware + — + DropboxApi::ConnectionBuilder + +
  • + #middleware + — + DropboxApi::Client + +
  • + #name + — + YARD::EndpointHandler + +
  • + #namespace_id + — + DropboxApi::Client + +
  • + #namespace_id + — + DropboxApi::MiddleWare::PathRoot + +
  • + #namespace_id= + — + DropboxApi::Client + +
  • + #namespace_id_header_value + — + DropboxApi::MiddleWare::PathRoot + +
  • + #offset= + — + DropboxApi::Metadata::UploadSessionCursor + +
  • + #parameters + — + YARD::EndpointHandler + +
  • + #path_prefix + — + DropboxScaffoldBuilder + +
  • + #perform_request + — + DropboxApi::Endpoints::ContentDownload + +
  • + #perform_request + — + DropboxApi::Endpoints::ContentUpload + +
  • + #prepend + — + DropboxApi::MiddleWare::Stack + +
  • + #process + — + RSpecItHandler + +
  • + #process + — + RSpecDescribeHandler + +
  • + #refresh_access_token + — + DropboxApi::ConnectionBuilder + +
  • + #request_body + — + DropboxApi::Endpoints::Rpc + +
  • + #resource + — + DropboxApi::Metadata::SearchMatchV2 + +
  • + #resource + — + DropboxApi::Results::Search::Match + +
  • + #resource + — + DropboxApi::Results::SaveCopyReferenceResult + +
  • + #resource + — + DropboxApi::Results::GetCopyReferenceResult + +
  • + #serialized_field + — + DropboxApi::Metadata::Base + +
  • + #session_id + — + DropboxApi::Results::UploadSessionStart + +
  • + #shared_folder + — + DropboxApi::Errors::AlreadySharedError + +
  • + #start + — + DropboxApi::ChunkedUploader + +
  • + #success? + — + DropboxApi::ResultBuilder + +
  • + #to_hash + — + DropboxApi::Metadata::File + +
  • + #to_hash + — + DropboxApi::Metadata::Folder + +
  • + #to_hash + — + DropboxApi::Metadata::Member + +
  • + #to_hash + — + DropboxApi::Metadata::NamespaceId + +
  • + #to_hash + — + DropboxApi::Metadata::WriteMode + +
  • + #to_hash + — + DropboxApi::Metadata::Base + +
  • + #to_hash + — + DropboxApi::Metadata::SharedLink + +
  • + #unindent + — + YARD::Templates::Helpers::HtmlHelper + +
  • + #untab + — + YARD::Templates::Helpers::HtmlHelper + +
  • + #upload + — + DropboxApi::ChunkedUploader + +
  • + #upload_by_chunks + — + DropboxApi::Client + +
  • + #users + — + DropboxApi::Results::SharedFileMembers + +
  • + #users + — + DropboxApi::Results::SharedFolderMembers + +
  • + #validate_options + — + DropboxApi::OptionsValidator +
+
+ + + + diff --git a/doc/yardoc/templates/default/fulldoc/html/css/common_css.html b/doc/yardoc/templates/default/fulldoc/html/css/common_css.html new file mode 100644 index 00000000..74c9cf16 --- /dev/null +++ b/doc/yardoc/templates/default/fulldoc/html/css/common_css.html @@ -0,0 +1,707 @@ + + + + + + +common.css - RDoc Documentation + + + + + + + + + + + + + + +
+ +

.test_code {

+ +
font-size: 13px;
+line-height: normal;
+ +

}

+
+ + + + + diff --git a/docs/DropboxApi.html b/docs/DropboxApi.html index 13c9c9b7..44706d54 100644 --- a/docs/DropboxApi.html +++ b/docs/DropboxApi.html @@ -6,15 +6,15 @@ Module: DropboxApi - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -109,7 +109,7 @@

VERSION =
-
'0.1.17'.freeze
+
'0.1.20'
@@ -125,9 +125,9 @@

diff --git a/docs/DropboxApi/Authenticator.html b/docs/DropboxApi/Authenticator.html index d934bcfb..76f2e385 100644 --- a/docs/DropboxApi/Authenticator.html +++ b/docs/DropboxApi/Authenticator.html @@ -6,15 +6,15 @@ Class: DropboxApi::Authenticator - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -87,11 +87,6 @@ -
-
Extended by:
-
Forwardable
-
- @@ -150,7 +145,6 @@

-

Constructor Details

@@ -165,7 +159,7 @@

-

Returns a new instance of Authenticator

+

Returns a new instance of Authenticator.

@@ -180,21 +174,21 @@

 
 
+6
 7
 8
 9
 10
-11
-12
+11 -
# File 'lib/dropbox_api/authenticator.rb', line 7
+      
# File 'lib/dropbox_api/authenticator.rb', line 6
 
 def initialize(client_id, client_secret)
-  @auth_code = OAuth2::Client.new(client_id, client_secret, {
-    :authorize_url => 'https://www.dropbox.com/oauth2/authorize',
-    :token_url => 'https://api.dropboxapi.com/oauth2/token'
-  }).auth_code
+  super(client_id, client_secret, {
+    authorize_url: 'https://www.dropbox.com/oauth2/authorize',
+    token_url: 'https://api.dropboxapi.com/oauth2/token'
+  })
 end
@@ -207,9 +201,9 @@

diff --git a/docs/DropboxApi/ChunkedUploader.html b/docs/DropboxApi/ChunkedUploader.html index 76448866..1123b049 100644 --- a/docs/DropboxApi/ChunkedUploader.html +++ b/docs/DropboxApi/ChunkedUploader.html @@ -6,15 +6,15 @@ Class: DropboxApi::ChunkedUploader - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -238,7 +238,7 @@

-

Returns a new instance of ChunkedUploader

+

Returns a new instance of ChunkedUploader.

@@ -253,17 +253,17 @@

 
 
-5
 6
 7
 8
 9
 10
 11
-12
+12 +13 -
# File 'lib/dropbox_api/chunked_uploader.rb', line 5
+      
# File 'lib/dropbox_api/chunked_uploader.rb', line 6
 
 def initialize(client, path, i_stream, options = {})
   @chunk_size = options.delete(:chunk_size) || 4 * 1024 * 1024 # 4 MiB
@@ -301,12 +301,12 @@ 

 
 
-31
 32
-33
+33 +34

-
# File 'lib/dropbox_api/chunked_uploader.rb', line 31
+      
# File 'lib/dropbox_api/chunked_uploader.rb', line 32
 
 def finish
   @client.upload_session_finish @cursor, @commit_info
@@ -332,19 +332,19 @@ 

 
 
-14
 15
 16
 17
 18
-19
+19 +20

-
# File 'lib/dropbox_api/chunked_uploader.rb', line 14
+      
# File 'lib/dropbox_api/chunked_uploader.rb', line 15
 
 def start
   chunk = @i_stream.read @chunk_size
-  chunk = "" if chunk.nil?
+  chunk = '' if chunk.nil?
 
   @cursor = @client.upload_session_start chunk
 end
@@ -369,7 +369,6 @@

 
 
-21
 22
 23
 24
@@ -377,10 +376,11 @@ 

26 27 28 -29

+29 +30

-
# File 'lib/dropbox_api/chunked_uploader.rb', line 21
+      
# File 'lib/dropbox_api/chunked_uploader.rb', line 22
 
 def upload
   loop do
@@ -401,9 +401,9 @@ 

diff --git a/docs/DropboxApi/Client.html b/docs/DropboxApi/Client.html index 7821bf4c..356f67ce 100644 --- a/docs/DropboxApi/Client.html +++ b/docs/DropboxApi/Client.html @@ -6,15 +6,15 @@ Class: DropboxApi::Client - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -1034,7 +1034,7 @@

  • - #search(query, path = "", options = {}) ⇒ Object + #search(query, options = nil, match_field_options = nil) ⇒ Object @@ -1051,6 +1051,29 @@

    Searches for files and folders.

    +

  • + + +
  • + + + #search_continue(cursor) ⇒ Object + + + + + + + + + + + + + +

    search:2.

    +
    +
  • @@ -1291,7 +1314,7 @@

  • - #initialize(oauth_bearer = ENV["DROPBOX_OAUTH_BEARER"]) ⇒ Client + #initialize(oauth_bearer = ENV['DROPBOX_OAUTH_BEARER'], access_token: nil, on_token_refreshed: nil) ⇒ Client @@ -1330,6 +1353,50 @@

    +
    + +

  • + + +
  • + + + #namespace_id ⇒ Object + + + + + + + + + + + + + +
    + +
  • + + +
  • + + + #namespace_id=(value) ⇒ Object + + + + + + + + + + + + +
  • @@ -1344,7 +1411,7 @@

    Constructor Details

    - #initialize(oauth_bearer = ENV["DROPBOX_OAUTH_BEARER"]) ⇒ Client + #initialize(oauth_bearer = ENV['DROPBOX_OAUTH_BEARER'], access_token: nil, on_token_refreshed: nil) ⇒ Client @@ -1352,7 +1419,7 @@

    -

    Returns a new instance of Client

    +

    Returns a new instance of Client.

    @@ -1367,15 +1434,41 @@

     
     
    -3
     4
    -5
    +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 -
    # File 'lib/dropbox_api/client.rb', line 3
    +      
    # File 'lib/dropbox_api/client.rb', line 4
     
    -def initialize(oauth_bearer = ENV["DROPBOX_OAUTH_BEARER"])
    -  @connection_builder = ConnectionBuilder.new(oauth_bearer)
    +def initialize(
    +  oauth_bearer = ENV['DROPBOX_OAUTH_BEARER'],
    +  access_token: nil,
    +  on_token_refreshed: nil
    +)
    +  if access_token
    +    @connection_builder = ConnectionBuilder.new(
    +      access_token: access_token,
    +      on_token_refreshed: on_token_refreshed
    +    )
    +  elsif oauth_bearer
    +    @connection_builder = ConnectionBuilder.new(oauth_bearer)
    +  else
    +    raise ArgumentError, "Either oauth_bearer or access_token should be set"
    +  end
     end
    @@ -1537,7 +1630,6 @@

     
     
    -6
     7
     8
     9
    @@ -1545,13 +1637,14 @@ 

    11 12 13 -14

    +14 +15

    -
    # File 'spec/endpoints/sharing/add_file_member_spec.rb', line 33
    +              
    # File 'spec/endpoints/sharing/add_file_member_spec.rb', line 34
     
    -file = "/bsd.pdf"
    -members = @client.add_file_member(file, "a@test.com")
    +file = '/bsd.pdf'
    +members = @client.add_file_member(file, 'a@test.com')
     
     expect(members)
       .to be_a(DropboxApi::Results::AddFileMemberResultList)
    @@ -1572,7 +1665,6 @@ 

     
     
    -18
     19
     20
     21
    @@ -1580,12 +1672,13 @@ 

    23 24 25 -26

    +26 +27

    -
    # File 'spec/endpoints/sharing/add_file_member_spec.rb', line 33
    +              
    # File 'spec/endpoints/sharing/add_file_member_spec.rb', line 34
     
    -file = "/bsd.pdf"
    +file = '/bsd.pdf'
     members = @client.add_file_member(file, %w(a@test.com b@test.com))
     
     expect(members)
    @@ -1607,21 +1700,21 @@ 

     
     
    -30
     31
     32
     33
     34
     35
    -36
    +36 +37

    -
    # File 'spec/endpoints/sharing/add_file_member_spec.rb', line 33
    +              
    # File 'spec/endpoints/sharing/add_file_member_spec.rb', line 34
     
    -file = "/bsd.pdf"
    +file = '/bsd.pdf'
     members = @client.add_file_member file,
    -                                  "a@test.com",
    -                                  :custom_message => "See my file down here."
    +                                  'a@test.com',
    +                                  custom_message: 'See my file down here.'
     
     expect(members)
       .to be_a(DropboxApi::Results::AddFileMemberResultList)
    @@ -1638,25 +1731,25 @@

     
     
    -40
     41
     42
     43
     44
     45
     46
    -47
    +47 +48

    -
    # File 'spec/endpoints/sharing/add_file_member_spec.rb', line 33
    +              
    # File 'spec/endpoints/sharing/add_file_member_spec.rb', line 34
     
    -file = "/bsd.pdf"
    +file = '/bsd.pdf'
     
     # Using :viewer_no_comment as access level will fail with no_permission.
     expect {
       @client.add_file_member file,
    -                          "a@test.com",
    -                          :access_level => :viewer_no_comment
    +                          'a@test.com',
    +                          access_level: :viewer_no_comment
     }.to raise_error(DropboxApi::Errors::NoPermissionError)
    @@ -1672,7 +1765,6 @@

     
     
    -33
     34
     35
     36
    @@ -1683,10 +1775,11 @@ 

    41 42 43 -44

    +44 +45

    -
    # File 'lib/dropbox_api/endpoints/sharing/add_file_member.rb', line 33
    +      
    # File 'lib/dropbox_api/endpoints/sharing/add_file_member.rb', line 34
     
     add_endpoint :add_file_member do |file, members, options = {}|
       validate_options([:quiet, :custom_message, :access_level, :add_message_as_comment], options)
    @@ -1696,8 +1789,8 @@ 

    options[:add_message_as_comment] ||= false perform_request options.merge({ - :file => file, - :members => build_members_param(members) + file: file, + members: build_members_param(members) }) end

    @@ -1842,14 +1935,14 @@

     
     
    -6
    -7
    +7 +8

    -
    # File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 38
    +              
    # File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39
     
    -folder_id = "1236358158"
    -folder = @client.add_folder_member folder_id, "somebody@test.com"
    +folder_id = '1236358158' +folder = @client.add_folder_member folder_id, 'somebody@test.com'
    @@ -1863,14 +1956,14 @@

     
     
    -13
    -14
    +14 +15

    -
    # File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 38
    +              
    # File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39
     
     folder_id = 1236358158
    -folder = @client.add_folder_member folder_id, "somebody@test.com"
    +folder = @client.add_folder_member folder_id, 'somebody@test.com'
    @@ -1884,14 +1977,14 @@

     
     
    -20
    -21
    +21 +22

    -
    # File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 38
    +              
    # File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39
     
     folder_id = 1236358158
    -folder = @client.add_folder_member folder_id, "somebody@test.com"
    +folder = @client.add_folder_member folder_id, 'somebody@test.com'
    @@ -1905,14 +1998,14 @@

     
     
    -27
    -28
    +28 +29 -
    # File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 38
    +              
    # File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39
     
     folder_id = 1236358158
    -folder = @client.add_folder_member folder_id, "somebody@test.com"
    +folder = @client.add_folder_member folder_id, 'somebody@test.com'
    @@ -1926,18 +2019,18 @@

     
     
    -34
     35
     36
     37
    -38
    +38 +39 -
    # File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 38
    +              
    # File 'spec/endpoints/sharing/add_folder_member_spec.rb', line 39
     
    -folder_id = "xxx"
    +folder_id = 'xxx'
     expect {
    -  folder = @client.add_folder_member folder_id, "somebody@test.com"
    +  folder = @client.add_folder_member folder_id, 'somebody@test.com'
     
     }.to raise_error(DropboxApi::Errors::InvalidIdError)
    @@ -1954,7 +2047,6 @@

     
     
    -38
     39
     40
     41
    @@ -1963,10 +2055,11 @@ 

    44 45 46 -47

    +47 +48

    -
    # File 'lib/dropbox_api/endpoints/sharing/add_folder_member.rb', line 38
    +      
    # File 'lib/dropbox_api/endpoints/sharing/add_folder_member.rb', line 39
     
     add_endpoint :add_folder_member do |folder_id, members, options = {}|
       validate_options([:quiet, :custom_message], options)
    @@ -1974,8 +2067,8 @@ 

    options[:custom_message] ||= nil perform_request options.merge({ - :shared_folder_id => folder_id.to_s, - :members => build_members_param(members) + shared_folder_id: folder_id.to_s, + members: build_members_param(members) }) end

    @@ -2067,18 +2160,18 @@

     
     
    -6
     7
     8
    -9
    +9 +10

    -
    # File 'spec/endpoints/files/copy_spec.rb', line 14
    +              
    # File 'spec/endpoints/files/copy_spec.rb', line 15
     
    -file = @client.copy("/a.jpg", "/b.jpg")
    +file = @client.copy('/a.jpg', '/b.jpg')
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("b.jpg")
    +expect(file.name).to eq('b.jpg')
    @@ -2092,15 +2185,15 @@

     
     
    -13
     14
    -15
    +15 +16 -
    # File 'spec/endpoints/files/copy_spec.rb', line 14
    +              
    # File 'spec/endpoints/files/copy_spec.rb', line 15
     
     expect {
    -  @client.copy("/z.jpg", "/b.jpg")
    +  @client.copy('/z.jpg', '/b.jpg')
     }.to raise_error(DropboxApi::Errors::NotFoundError)
    @@ -2115,15 +2208,15 @@

     
     
    -19
     20
    -21
    +21 +22

    -
    # File 'spec/endpoints/files/copy_spec.rb', line 14
    +              
    # File 'spec/endpoints/files/copy_spec.rb', line 15
     
     expect {
    -  @client.copy("/../invalid_path.jpg", "/b.jpg")
    +  @client.copy('/../invalid_path.jpg', '/b.jpg')
     }.to raise_error(DropboxApi::Errors::MalformedPathError)
    @@ -2139,20 +2232,20 @@

     
     
    -14
     15
     16
     17
     18
    -19
    +19 +20

    -
    # File 'lib/dropbox_api/endpoints/files/copy.rb', line 14
    +      
    # File 'lib/dropbox_api/endpoints/files/copy.rb', line 15
     
     add_endpoint :copy do |from, to|
       perform_request({
    -    :from_path => from,
    -    :to_path => to
    +    from_path: from,
    +    to_path: to
       })
     end
    @@ -2261,24 +2354,24 @@

     
     
    -7
     8
     9
     10
     11
     12
    -13
    +13 +14

    -
    # File 'spec/endpoints/files/copy_batch_spec.rb', line 24
    +              
    # File 'spec/endpoints/files/copy_batch_spec.rb', line 25
     
     job_id = @client.copy_batch [{
    -  :from_path => "#{path_prefix}/regular_file.txt",
    -  :to_path => "#{path_prefix}/regular_file_renamed.txt"
    +  from_path: "#{path_prefix}/regular_file.txt",
    +  to_path: "#{path_prefix}/regular_file_renamed.txt"
     }]
     
     expect(job_id)
    -  .to eq("dbjid:AAA6b4uwc19nEau5k-OBI_h-hjrR7pNDaUA3_0hOwV-UZ2pkw_zXWp3FSuVZrQ0d9IXKGkwB5JdYI4mJZumLc6qZ")
    + .to eq('dbjid:AAA6b4uwc19nEau5k-OBI_h-hjrR7pNDaUA3_0hOwV-UZ2pkw_zXWp3FSuVZrQ0d9IXKGkwB5JdYI4mJZumLc6qZ')
    @@ -2292,24 +2385,24 @@

     
     
    -17
     18
     19
     20
     21
     22
    -23
    +23 +24 -
    # File 'spec/endpoints/files/copy_batch_spec.rb', line 24
    +              
    # File 'spec/endpoints/files/copy_batch_spec.rb', line 25
     
     job_id = @client.copy_batch([{
    -  :from_path => "#{path_prefix}/regular_file_2.txt",
    -  :to_path => "#{path_prefix}/regular_file_2_renamed.txt"
    -}], :autorename => true)
    +  from_path: "#{path_prefix}/regular_file_2.txt",
    +  to_path: "#{path_prefix}/regular_file_2_renamed.txt"
    +}], autorename: true)
     
     expect(job_id)
    -  .to eq("dbjid:AABe-bOUUq5nrybciMJxIxaGAD16nGCKByGyY3Z_2m6kshGW903XTikVT3_5V6JQQu20p3QxoCfws7_hT40deF6q")
    + .to eq('dbjid:AABe-bOUUq5nrybciMJxIxaGAD16nGCKByGyY3Z_2m6kshGW903XTikVT3_5V6JQQu20p3QxoCfws7_hT40deF6q')
    @@ -2324,7 +2417,6 @@

     
     
    -24
     25
     26
     27
    @@ -2333,10 +2425,11 @@ 

    30 31 32 -33

    +33 +34 -
    # File 'lib/dropbox_api/endpoints/files/copy_batch.rb', line 24
    +      
    # File 'lib/dropbox_api/endpoints/files/copy_batch.rb', line 25
     
     add_endpoint :copy_batch do |entries, options = {}|
       validate_options([
    @@ -2345,7 +2438,7 @@ 

    options[:autorename] ||= false perform_request(options.merge({ - :entries => entries + entries: entries })) end

    @@ -2425,16 +2518,16 @@

     
     
    -6
     7
     8
     9
    -10
    +10 +11

    -
    # File 'spec/endpoints/files/copy_batch_check_spec.rb', line 16
    +              
    # File 'spec/endpoints/files/copy_batch_check_spec.rb', line 17
     
    -result = @client.copy_batch_check "dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsU"
    +result = @client.copy_batch_check 'dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsU'
     
     expect(result).to include(a_kind_of(DropboxApi::Metadata::Folder))
     expect(result).to include(a_kind_of(DropboxApi::Metadata::File))
    @@ -2452,15 +2545,15 @@ 

     
     
    -14
     15
    -16
    +16 +17

    -
    # File 'spec/endpoints/files/copy_batch_check_spec.rb', line 16
    +              
    # File 'spec/endpoints/files/copy_batch_check_spec.rb', line 17
     
     expect {
    -  @client.copy_batch_check "dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsE"
    +  @client.copy_batch_check 'dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsE'
     }.to raise_error(DropboxApi::Errors::InvalidIdError)
    @@ -2476,15 +2569,15 @@

     
     
    -16
     17
    -18
    +18 +19

    -
    # File 'lib/dropbox_api/endpoints/files/copy_batch_check.rb', line 16
    +      
    # File 'lib/dropbox_api/endpoints/files/copy_batch_check.rb', line 17
     
     add_endpoint :copy_batch_check do |async_job_id|
    -  perform_request :async_job_id => async_job_id
    +  perform_request async_job_id: async_job_id
     end
    @@ -2546,24 +2639,112 @@

    +
    +

    Specifications:

    +
      + +
    • + returns a copy reference + + + + + +
      +
      +
      +
      +8
      +9
      +10
      +11
      +12
      +13
      +
      +
      # File 'spec/endpoints/files/copy_reference_get_spec.rb', line 16
      +
      +result = @client.copy_reference_get '/file.txt'
      +
      +expect(result).to be_a(DropboxApi::Results::GetCopyReferenceResult)
      +expect(result.resource.name).to eq('file.txt')
      +expect(result.copy_reference).to be_a(String)
      +expect(result.expires).to be_a(Time)
      +
      +
    • + +
    • + returns a copy reference + + + + + +
      +
      +
      +
      +19
      +20
      +21
      +22
      +23
      +24
      +
      +
      # File 'spec/endpoints/files/copy_reference_get_spec.rb', line 16
      +
      +result = @client.copy_reference_get('/folder')
      +
      +expect(result).to be_a(DropboxApi::Results::GetCopyReferenceResult)
      +expect(result.resource.name).to eq('folder')
      +expect(result.copy_reference).to be_a(String)
      +expect(result.expires).to be_a(Time)
      +
      +
    • + +
    • + raises an error + + + + + +
      +
      +
      +
      +30
      +31
      +32
      +
      +
      # File 'spec/endpoints/files/copy_reference_get_spec.rb', line 16
      +
      +expect {
      +  @client.copy_reference_get('/c.jpg')
      +}.to raise_error(DropboxApi::Errors::NotFoundError)
      +
      +
    • + +
    +
    + @@ -2640,26 +2821,200 @@

    -

     
     
    -15
     16
     17
     18
    -19
    +19 +20
    -
    # File 'lib/dropbox_api/endpoints/files/copy_reference_get.rb', line 15
    +      
    # File 'lib/dropbox_api/endpoints/files/copy_reference_get.rb', line 16
     
     add_endpoint :copy_reference_get do |path|
       perform_request({
    -    :path => path
    +    path: path
       })
     end
    - - @@ -2873,18 +3228,18 @@

     
     
    -6
     7
     8
    -9
    +9 +10

    -
    +
    +

    Specifications:

    +
      + +
    • + returns the saved file + + + - + + +
      +
       
       
      -15
      -16
      -17
      -18
      -19
      -20
      -
      -
      # File 'lib/dropbox_api/endpoints/files/copy_reference_save.rb', line 15
      +10
      +11
      +12
      +13
      +
      +
      # File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16
      +
      +result = @client.copy_reference_save @copy_reference, '/copied-file.txt'
      +
      +expect(result).to be_a(DropboxApi::Results::SaveCopyReferenceResult)
      +expect(result.resource.name).to eq('copied-file.txt')
      +
      +
    • + +
    • + returns the saved folder + + + + + +
      +
      +
      +
      +19
      +20
      +21
      +22
      +23
      +
      +
      # File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16
      +
      +copy_reference = 'WI-v42h5NWxnbDZ2enpjbw'
      +result = @client.copy_reference_save copy_reference, '/copied-folder'
      +
      +expect(result).to be_a(DropboxApi::Results::SaveCopyReferenceResult)
      +expect(result.resource.name).to eq('copied-folder')
      +
      +
    • + +
    • + raises an error + + + + + +
      +
      +
      +
      +30
      +31
      +32
      +
      +
      # File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16
      +
      +expect {
      +  @client.copy_reference_save @copy_reference, '/copied-file.txt'
      +}.to raise_error(DropboxApi::Errors::FileConflictError)
      +
      +
    • + +
    • + raises an error + + + + + +
      +
      +
      +
      +38
      +39
      +40
      +
      +
      # File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16
      +
      +expect {
      +  @client.copy_reference_save 'invalid-reference', '/copied-file.txt'
      +}.to raise_error(DropboxApi::Errors::InvalidCopyReferenceError)
      +
      +
    • + +
    • + raises an error + + + + + +
      +
      +
      +
      +46
      +47
      +48
      +
      +
      # File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16
      +
      +expect {
      +  @client.copy_reference_save @copy_reference, '//copied-file.txt'
      +}.to raise_error(DropboxApi::Errors::MalformedPathError)
      +
      +
    • + +
    • + raises an error + + + + + +
      +
      +
      +
      +54
      +55
      +56
      +
      +
      # File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16
      +
      +expect {
      +  @client.copy_reference_save @copy_reference, '/copied-file.txt'
      +}.to raise_error(DropboxApi::Errors::NoPermissionError)
      +
      +
    • + +
    • + raises an error + + + + + +
      +
      +
      +
      +62
      +63
      +64
      +
      +
      # File 'spec/endpoints/files/copy_reference_save_spec.rb', line 16
      +
      +expect {
      +  @client.copy_reference_save @copy_reference, '/copied-file.txt'
      +}.to raise_error(DropboxApi::Errors::NotFoundError)
      +
      +
    • + +
    +
    + + + + + @@ -2735,18 +3090,18 @@

     
     
    -7
     8
     9
    -10
    +10 +11

    +
    +
    +
    +16
    +17
    +18
    +19
    +20
    +21
    +
    +
    # File 'lib/dropbox_api/endpoints/files/copy_reference_save.rb', line 16
     
     add_endpoint :copy_reference_save do |copy_reference, path|
       perform_request({
    -    :copy_reference => copy_reference,
    -    :path => path
    +    copy_reference: copy_reference,
    +    path: path
       })
     end
    -
    # File 'spec/endpoints/file_requests/create_file_request_spec.rb', line 14
    +              
    # File 'spec/endpoints/file_requests/create_file_request_spec.rb', line 15
     
     file_request = @client.create_file_request 'Arizona, baby', "#{path_prefix}/arizona_baby"
     
     expect(file_request).to be_a(DropboxApi::Metadata::FileRequest)
    -expect(file_request.title).to eq("Arizona, baby")
    +expect(file_request.title).to eq('Arizona, baby')
    @@ -2760,12 +3115,12 @@

     
     
    -14
     15
    -16
    +16 +17

    -
    # File 'spec/endpoints/file_requests/create_file_request_spec.rb', line 14
    +              
    # File 'spec/endpoints/file_requests/create_file_request_spec.rb', line 15
     
     expect {
       @client.create_file_request 'Arizona, baby', "#{path_prefix}/regular_file.txt"
    @@ -2784,20 +3139,20 @@ 

     
     
    -14
     15
     16
     17
     18
    -19
    +19 +20

    -
    # File 'lib/dropbox_api/endpoints/file_requests/create_file_request.rb', line 14
    +      
    # File 'lib/dropbox_api/endpoints/file_requests/create_file_request.rb', line 15
     
     add_endpoint :create_file_request do |title, destination|
       perform_request({
    -    :title => title,
    -    :destination => destination
    +    title: title,
    +    destination: destination
       })
     end
    -
    # File 'spec/endpoints/files/create_folder_spec.rb', line 12
    +              
    # File 'spec/endpoints/files/create_folder_spec.rb', line 13
     
    -folder = @client.create_folder("/arizona_baby")
    +folder = @client.create_folder('/arizona_baby')
     
     expect(folder).to be_a(DropboxApi::Metadata::Folder)
    -expect(folder.name).to eq("arizona_baby")
    +expect(folder.name).to eq('arizona_baby')
    @@ -2898,15 +3253,15 @@

     
     
    -13
     14
    -15
    +15 +16 -
    # File 'spec/endpoints/files/create_folder_spec.rb', line 12
    +              
    # File 'spec/endpoints/files/create_folder_spec.rb', line 13
     
     expect {
    -  @client.create_folder("/arizona\\baby")
    +  @client.create_folder('/arizona\\baby')
     }.to raise_error(DropboxApi::Errors::MalformedPathError)
    @@ -2921,15 +3276,15 @@

     
     
    -19
     20
    -21
    +21 +22

    -
    # File 'spec/endpoints/files/create_folder_spec.rb', line 12
    +              
    # File 'spec/endpoints/files/create_folder_spec.rb', line 13
     
     expect {
    -  @client.create_folder("/b.jpg")
    +  @client.create_folder('/b.jpg')
     }.to raise_error(DropboxApi::Errors::FileConflictError)
    @@ -2945,18 +3300,18 @@

     
     
    -12
     13
     14
     15
    -16
    +16 +17

    -
    # File 'lib/dropbox_api/endpoints/files/create_folder.rb', line 12
    +      
    # File 'lib/dropbox_api/endpoints/files/create_folder.rb', line 13
     
     add_endpoint :create_folder do |path|
       perform_request({
    -    :path => path
    +    path: path
       })
     end
    @@ -3079,15 +3434,15 @@

     
     
    -6
     7
     8
    -9
    +9 +10

    -
    # File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27
    +              
    # File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28
     
    -result = @client.create_folder_batch ["/Create Batch", "/Create Batch 1"]
    +result = @client.create_folder_batch ['/Create Batch', '/Create Batch 1']
     
     expect(result.first).to be_a(DropboxApi::Metadata::Folder)
     expect(result.last).to be_a(DropboxApi::Metadata::Folder)
    @@ -3104,22 +3459,22 @@

     
     
    -13
     14
     15
     16
     17
    -18
    +18 +19

    -
    # File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27
    +              
    # File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28
     
     paths = []
     100.times { |i| paths << "/Folder #{i}"}
     
     async_result = @client.create_folder_batch(paths)
     expect(async_result).to be_a(Hash)
    -expect(async_result).to have_key("async_job_id")
    +expect(async_result).to have_key('async_job_id')
    @@ -3133,18 +3488,18 @@

     
     
    -22
     23
     24
    -25
    +25 +26 -
    # File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27
    +              
    # File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28
     
    -async_result = @client.create_folder_batch(["/Create Batch 2", "/Create Batch 3"], { :force_async => true })
    +async_result = @client.create_folder_batch(['/Create Batch 2', '/Create Batch 3'], { force_async: true })
     
     expect(async_result).to be_a(Hash)
    -expect(async_result).to have_key("async_job_id")
    +expect(async_result).to have_key('async_job_id')
    @@ -3158,14 +3513,14 @@

     
     
    -29
     30
    -31
    +31 +32 -
    # File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27
    +              
    # File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28
     
    -result = @client.create_folder_batch(["/Create Batch 1", "/Create Batch 1"], { :autorename => true })
    +result = @client.create_folder_batch(['/Create Batch 1', '/Create Batch 1'], { autorename: true })
     
     expect(result).not_to include(a_kind_of(DropboxApi::Errors::FolderConflictError))
    @@ -3181,15 +3536,15 @@

     
     
    -35
     36
    -37
    +37 +38

    -
    # File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27
    +              
    # File 'spec/endpoints/files/create_folder_batch_spec.rb', line 28
     
     expect {
    -  @client.create_folder_batch(["/Create Batch 4", "/Create Batch 5"], { :async => true })
    +  @client.create_folder_batch(['/Create Batch 4', '/Create Batch 5'], { async: true })
     }.to raise_error(ArgumentError)
    @@ -3205,7 +3560,6 @@

     
     
    -27
     28
     29
     30
    @@ -3216,10 +3570,11 @@ 

    35 36 37 -38

    +38 +39

    -
    # File 'lib/dropbox_api/endpoints/files/create_folder_batch.rb', line 27
    +      
    # File 'lib/dropbox_api/endpoints/files/create_folder_batch.rb', line 28
     
     add_endpoint :create_folder_batch do |paths, options = {}|
       validate_options([
    @@ -3230,7 +3585,7 @@ 

    options[:force_async] ||= false perform_request(options.merge({ - :paths => paths + paths: paths })) end

    @@ -3309,16 +3664,16 @@

     
     
    -6
     7
     8
     9
    -10
    +10 +11

    -
    # File 'spec/endpoints/files/create_folder_batch_check_spec.rb', line 15
    +              
    # File 'spec/endpoints/files/create_folder_batch_check_spec.rb', line 16
     
    -async_result = @client.create_folder_batch_check("dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQE")
    +async_result = @client.create_folder_batch_check('dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQE')
     
     expect(async_result).to include(a_kind_of(DropboxApi::Metadata::Folder))
     expect(async_result).to include(a_kind_of(DropboxApi::Errors::MalformedPathError))
    @@ -3336,15 +3691,15 @@ 

     
     
    -14
     15
    -16
    +16 +17

    -
    # File 'spec/endpoints/files/create_folder_batch_check_spec.rb', line 15
    +              
    # File 'spec/endpoints/files/create_folder_batch_check_spec.rb', line 16
     
     expect {
    -  @client.create_folder_batch_check("dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT")
    +  @client.create_folder_batch_check('dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT')
     }.to raise_error(DropboxApi::Errors::InvalidIdError)
    @@ -3360,18 +3715,18 @@

     
     
    -15
     16
     17
     18
    -19
    +19 +20

    -
    # File 'lib/dropbox_api/endpoints/files/create_folder_batch_check.rb', line 15
    +      
    # File 'lib/dropbox_api/endpoints/files/create_folder_batch_check.rb', line 16
     
     add_endpoint :create_folder_batch_check do |async_job_id|
       perform_request({
    -    :async_job_id => async_job_id
    +    async_job_id: async_job_id
       })
     end
    @@ -3507,47 +3862,215 @@

    - - -
    -
    +
    +

    Specifications:

    +
      + +
    • + creates a shared link for basic and pro users + + + - + +expect(link).tobe_a(DropboxApi::Metadata::FileLinkMetadata) + + +
      +
       
       
      -31
      -32
      -33
      -34
      -35
      -36
      -37
      -38
      -39
      -40
      -41
      -42
      -43
      -44
      -45
      -
      -
      # File 'lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb', line 31
      +8
      +9
      +10
      +
      +
      # File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32
       
      -add_endpoint :create_shared_link_with_settings do |path, settings = {}|
      -  validate_options([
      -    :requested_visibility,
      -    :link_password,
      -    :expires
      -  ], settings)
      -  settings[:requested_visibility] ||= 'public'
      -  settings[:link_password] ||= nil
      -  settings[:expires] ||= nil
      +link = @client.create_shared_link_with_settings '/file_for_sharing.docx'
       
      -  perform_request({
      -    :path => path,
      -    :settings => settings
      -  })
      -end
      -
      +
    • + +
    • + creates a shared link with settings for pro users + + + + + +
      +
      +
      +
      +14
      +15
      +16
      +
      +
      # File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32
      +
      +link = @client.create_shared_link_with_settings('/file_for_sharing.docx', { expires: '2019-03-12T10:34:42Z' })
      +
      +expect(link).to be_a(DropboxApi::Metadata::FileLinkMetadata)
      +
      +
    • + +
    • + raises an error if settings options are passed for basic users + + + + + +
      +
      +
      +
      +20
      +21
      +22
      +
      +
      # File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32
      +
      +expect {
      +  @client.create_shared_link_with_settings('/file_for_sharing.docx', { expires: '2019-03-12T10:34:42Z' })
      +}.to raise_error(DropboxApi::Errors::NoPermissionError)
      +
      +
    • + +
    • + raises an error if already shared for basic and pro users + + + + + +
      +
      +
      +
      +26
      +27
      +28
      +
      +
      # File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32
      +
      +expect {
      +  @client.create_shared_link_with_settings '/file_for_sharing.docx'
      +}.to raise_error(DropboxApi::Errors::SharedLinkAlreadyExistsError)
      +
      +
    • + +
    • + creates a shared link for basic and pro users + + + + + +
      +
      +
      +
      +34
      +35
      +36
      +
      +
      # File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32
      +
      +link = @client.create_shared_link_with_settings '/folder_for_sharing'
      +
      +expect(link).to be_a(DropboxApi::Metadata::FolderLinkMetadata)
      +
      +
    • + +
    • + creates a shared link with settings for pro users + + + + + +
      +
      +
      +
      +40
      +41
      +42
      +
      +
      # File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32
      +
      +link = @client.create_shared_link_with_settings('/folder_for_sharing', { expires: '2019-03-12T10:34:42Z' })
      +
      +expect(link).to be_a(DropboxApi::Metadata::FolderLinkMetadata)
      +
      +
    • + +
    • + raises an error if settings options are passed for basic user + + + + + +
      +
      +
      +
      +46
      +47
      +48
      +
      +
      # File 'spec/endpoints/sharing/create_shared_link_with_settings_spec.rb', line 32
      +
      +expect {
      +  @client.create_shared_link_with_settings('/folder_for_sharing', { expires: '2019-03-12T10:34:42Z' })
      +}.to raise_error(DropboxApi::Errors::NoPermissionError)
      +
      +
    • + +
    +
    + + + + +
    +
    +
    +
    +32
    +33
    +34
    +35
    +36
    +37
    +38
    +39
    +40
    +41
    +42
    +43
    +44
    +45
    +46
    +
    +
    # File 'lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb', line 32
    +
    +add_endpoint :create_shared_link_with_settings do |path, settings = {}|
    +  validate_options([
    +    :requested_visibility,
    +    :link_password,
    +    :expires
    +  ], settings)
    +  settings[:requested_visibility] ||= 'public'
    +  settings[:link_password] ||= nil
    +  settings[:expires] ||= nil
    +
    +  perform_request({
    +    path: path,
    +    settings: settings
    +  })
    +end
    +
    @@ -3636,18 +4159,18 @@

     
     
    -7
     8
     9
    -10
    +10 +11

    -
    # File 'spec/endpoints/files/delete_spec.rb', line 24
    +              
    # File 'spec/endpoints/files/delete_spec.rb', line 25
     
     file = @client.delete "#{path_prefix}/will_be_deleted.txt"
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("will_be_deleted.txt")
    +expect(file.name).to eq('will_be_deleted.txt')
    @@ -3661,15 +4184,15 @@

     
     
    -14
     15
    -16
    +16 +17 -
    # File 'spec/endpoints/files/delete_spec.rb', line 24
    +              
    # File 'spec/endpoints/files/delete_spec.rb', line 25
     
     expect {
    -  @client.delete "#{path_prefix}/wont_be_deleted.txt", :parent_rev => "1c0576c68d6"
    +  @client.delete "#{path_prefix}/wont_be_deleted.txt", parent_rev: '1c0576c68d6'
     }.to raise_error(DropboxApi::Errors::FileConflictError)
    @@ -3684,18 +4207,18 @@

     
     
    -20
     21
     22
    -23
    +23 +24

    -
    # File 'spec/endpoints/files/delete_spec.rb', line 24
    +              
    # File 'spec/endpoints/files/delete_spec.rb', line 25
     
     folder = @client.delete "#{path_prefix}/folder"
     
     expect(folder).to be_a(DropboxApi::Metadata::Folder)
    -expect(folder.name).to eq("folder")
    +expect(folder.name).to eq('folder')
    @@ -3709,15 +4232,15 @@

     
     
    -27
     28
    -29
    +29 +30 -
    # File 'spec/endpoints/files/delete_spec.rb', line 24
    +              
    # File 'spec/endpoints/files/delete_spec.rb', line 25
     
     expect {
    -  @client.delete "/unexisting folder"
    +  @client.delete '/unexisting folder'
     }.to raise_error(DropboxApi::Errors::NotFoundError)
    @@ -3733,22 +4256,22 @@

     
     
    -24
     25
     26
     27
     28
     29
    -30
    +30 +31

    -
    # File 'lib/dropbox_api/endpoints/files/delete.rb', line 24
    +      
    # File 'lib/dropbox_api/endpoints/files/delete.rb', line 25
     
     add_endpoint :delete do |path, options = {}|
       validate_options([:parent_rev], options)
     
       perform_request options.merge({
    -    :path => path
    +    path: path
       })
     end
    @@ -3829,20 +4352,20 @@

     
     
    -8
     9
     10
     11
    -12
    +12 +13

    -
    # File 'spec/endpoints/files/delete_batch_spec.rb', line 16
    +              
    # File 'spec/endpoints/files/delete_batch_spec.rb', line 17
     
    -entries = [{ :path => "/folder_to_delete_1" }, { :path => "/folder_to_delete_2" }]
    +entries = [{ path: '/folder_to_delete_1' }, { path: '/folder_to_delete_2' }]
     async_result = @client.delete_batch entries
     
     expect(async_result).to be_a(Hash)
    -expect(async_result).to have_key("async_job_id")
    +expect(async_result).to have_key('async_job_id')
    @@ -3856,20 +4379,20 @@

     
     
    -16
     17
     18
     19
    -20
    +20 +21 -
    # File 'spec/endpoints/files/delete_batch_spec.rb', line 16
    +              
    # File 'spec/endpoints/files/delete_batch_spec.rb', line 17
     
    -entries = [{ :path => "/folder_to_delete/file_to_delete.docx", :parent_rev => "1c0576c68d6" }]
    +entries = [{ path: '/folder_to_delete/file_to_delete.docx', parent_rev: '1c0576c68d6' }]
     async_result = @client.delete_batch entries
     
     expect(async_result).to be_a(Hash)
    -expect(async_result).to have_key("async_job_id")
    +expect(async_result).to have_key('async_job_id')
    @@ -3884,18 +4407,18 @@

     
     
    -16
     17
     18
     19
    -20
    +20 +21 -
    # File 'lib/dropbox_api/endpoints/files/delete_batch.rb', line 16
    +      
    # File 'lib/dropbox_api/endpoints/files/delete_batch.rb', line 17
     
     add_endpoint :delete_batch do |entries|
       perform_request({
    -    :entries => entries
    +    entries: entries
       })
     end
    @@ -3973,17 +4496,17 @@

     
     
    -6
     7
     8
     9
     10
    -11
    +11 +12

    -
    # File 'spec/endpoints/files/delete_batch_check_spec.rb', line 14
    +              
    # File 'spec/endpoints/files/delete_batch_check_spec.rb', line 15
     
    -async_result = @client.delete_batch_check("dbjid:AAC2JUPMEtK-kEg7QVrNEemnX-FfQkJ_0r_tJJ2UpHhwvrUGrpw19CH4U5cfZKWPLxLVJoKgffTOy_zSKk6W953h")
    +async_result = @client.delete_batch_check('dbjid:AAC2JUPMEtK-kEg7QVrNEemnX-FfQkJ_0r_tJJ2UpHhwvrUGrpw19CH4U5cfZKWPLxLVJoKgffTOy_zSKk6W953h')
     
     expect(async_result).to include(a_kind_of(DropboxApi::Metadata::Folder))
     expect(async_result).to include(a_kind_of(DropboxApi::Metadata::File))
    @@ -4002,15 +4525,15 @@ 

     
     
    -15
     16
    -17
    +17 +18

    -
    # File 'spec/endpoints/files/delete_batch_check_spec.rb', line 14
    +              
    # File 'spec/endpoints/files/delete_batch_check_spec.rb', line 15
     
     expect {
    -  @client.delete_batch_check("dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT")
    +  @client.delete_batch_check('dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT')
     }.to raise_error(DropboxApi::Errors::InvalidIdError)
    @@ -4026,18 +4549,18 @@

     
     
    -14
     15
     16
     17
    -18
    +18 +19

    -
    # File 'lib/dropbox_api/endpoints/files/delete_batch_check.rb', line 14
    +      
    # File 'lib/dropbox_api/endpoints/files/delete_batch_check.rb', line 15
     
     add_endpoint :delete_batch_check do |async_job_id|
       perform_request({
    -    :async_job_id => async_job_id
    +    async_job_id: async_job_id
       })
     end
    @@ -4096,18 +4619,18 @@

     
     
    -6
     7
     8
    -9
    +9 +10

    -
    # File 'spec/endpoints/files/download_spec.rb', line 11
    +              
    # File 'spec/endpoints/files/download_spec.rb', line 12
     
    -file = @client.download "/file.txt"
    +file = @client.download '/file.txt'
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("file.txt")
    +expect(file.name).to eq('file.txt')
    @@ -4121,22 +4644,22 @@

     
     
    -13
     14
     15
     16
     17
    -18
    +18 +19

    -
    # File 'spec/endpoints/files/download_spec.rb', line 11
    +              
    # File 'spec/endpoints/files/download_spec.rb', line 12
     
    -file_contents = ""
    -file = @client.download "/file.txt" do |chunk|
    -  file_contents << chunk
    +file_contents = ''
    +file = @client.download '/file.txt' do |chunk|
    +  file_contents = "#{file_contents}#{chunk}"
     end
     
    -expect(file_contents).to eq("Viva Rusia!\n")
    +expect(file_contents).to eq("Hola Leo!\n")
    @@ -4150,15 +4673,15 @@

     
     
    -22
     23
    -24
    +24 +25 -
    # File 'spec/endpoints/files/download_spec.rb', line 11
    +              
    # File 'spec/endpoints/files/download_spec.rb', line 12
     
     expect {
    -  @client.download("/c.jpg")
    +  @client.download('/c.jpg')
     }.to raise_error(DropboxApi::Errors::NotFoundError)
    @@ -4174,15 +4697,15 @@

     
     
    -11
     12
    -13
    +13 +14

    -
    # File 'lib/dropbox_api/endpoints/files/download.rb', line 11
    +      
    # File 'lib/dropbox_api/endpoints/files/download.rb', line 12
     
     add_endpoint :download do |path, &block|
    -  perform_request({:path => path}, &block)
    +  perform_request({path: path}, &block)
     end
    @@ -4257,14 +4780,14 @@

     
     
    -6
     7
    -8
    +8 +9

    -
    # File 'spec/endpoints/users/get_account_spec.rb', line 12
    +              
    # File 'spec/endpoints/users/get_account_spec.rb', line 13
     
    - = @client. "dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs"
    + = @client. 'dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs'
     
     expect().to be_a(DropboxApi::Metadata::BasicAccount)
    @@ -4280,15 +4803,15 @@

     
     
    -12
     13
    -14
    +14 +15

    -
    # File 'spec/endpoints/users/get_account_spec.rb', line 12
    +              
    # File 'spec/endpoints/users/get_account_spec.rb', line 13
     
     expect {
    -  @client. "dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX"
    +  @client. 'dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX'
     }.to raise_error(DropboxApi::Errors::NoAccountError)
    @@ -4304,15 +4827,15 @@

     
     
    -12
     13
    -14
    +14 +15

    -
    # File 'lib/dropbox_api/endpoints/users/get_account.rb', line 12
    +      
    # File 'lib/dropbox_api/endpoints/users/get_account.rb', line 13
     
     add_endpoint :get_account do ||
    -  perform_request :account_id => 
    +  perform_request account_id: 
     end
    @@ -4389,7 +4912,6 @@

     
     
    -6
     7
     8
     9
    @@ -4399,14 +4921,15 @@ 

    13 14 15 -16

    +16 +17

    -
    # File 'spec/endpoints/users/get_account_batch_spec.rb', line 14
    +              
    # File 'spec/endpoints/users/get_account_batch_spec.rb', line 15
     
     test_accounts = {
    -  "dbid:AACiYqkuK0t_wIvlr9BduHKdhzk_H28Dg0U" => "Antonio Hidalgo",
    -  "dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs" => "Jesus Burgos"
    +  'dbid:AACiYqkuK0t_wIvlr9BduHKdhzk_H28Dg0U' => 'Antonio Hidalgo',
    +  'dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs' => 'Jesus Burgos'
     }
     accounts = @client. test_accounts.keys
     
    @@ -4421,24 +4944,24 @@ 

  • - raises an error if one account can't e found + raises an error if one account cannot be found @@ -4526,12 +5049,12 @@

     
     
    -6
     7
    -8
    +8 +9

     
     
    -20
     21
     22
     23
     24
     25
     26
    -27
    +27 +28
    -
    # File 'spec/endpoints/users/get_account_batch_spec.rb', line 14
    +              
    # File 'spec/endpoints/users/get_account_batch_spec.rb', line 15
     
      = %w(
       dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX
    @@ -4462,15 +4985,15 @@ 

     
     
    -14
     15
    -16
    +16 +17

    -
    # File 'lib/dropbox_api/endpoints/users/get_account_batch.rb', line 14
    +      
    # File 'lib/dropbox_api/endpoints/users/get_account_batch.rb', line 15
     
     add_endpoint :get_account_batch do ||
    -  perform_request :account_ids => 
    +  perform_request account_ids: 
     end
    -
    # File 'spec/endpoints/users/get_space_usage_spec.rb', line 11
    +              
    # File 'spec/endpoints/users/get_space_usage_spec.rb', line 12
     
     space_usage = @client.get_space_usage
     
    @@ -4549,16 +5072,18 @@ 

     
     
    -6
     7
    -8
    +8 +9 +10

    -
    # File 'spec/endpoints/users/get_current_account_spec.rb', line 11
    +              
    # File 'spec/endpoints/users/get_current_account_spec.rb', line 12
     
      = @client.
     
    -expect().to be_a(DropboxApi::Metadata::BasicAccount)
    +expect().to be_a(DropboxApi::Metadata::BasicAccount) +expect(.root_info).to be_a(DropboxApi::Metadata::UserRootInfo)
    @@ -4573,12 +5098,12 @@

     
     
    -11
     12
    -13
    +13 +14

  • -
    # File 'lib/dropbox_api/endpoints/users/get_current_account.rb', line 11
    +      
    # File 'lib/dropbox_api/endpoints/users/get_current_account.rb', line 12
     
     add_endpoint :get_current_account do
       perform_request nil
    @@ -4699,18 +5224,18 @@ 

     
     
    -7
     8
     9
    -10
    +10 +11

    -
    # File 'spec/endpoints/files/get_metadata_spec.rb', line 29
    +              
    # File 'spec/endpoints/files/get_metadata_spec.rb', line 30
     
     file = @client.("#{path_prefix}/file.txt")
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("file.txt")
    +expect(file.name).to eq('file.txt')
    @@ -4724,16 +5249,16 @@

     
     
    -14
     15
    -16
    +16 +17

    -
    # File 'spec/endpoints/files/get_metadata_spec.rb', line 29
    +              
    # File 'spec/endpoints/files/get_metadata_spec.rb', line 30
     
     file = @client.("#{path_prefix}/file.txt")
     
    -expect(file.client_modified).to eq(Time.new(1988, 12, 8, 1, 1, 0, "+00:00"))
    +expect(file.client_modified).to eq(Time.new(1988, 12, 8, 1, 1, 0, '+00:00'))
    @@ -4747,18 +5272,18 @@

     
     
    -20
     21
     22
    -23
    +23 +24

    -
    # File 'spec/endpoints/files/get_metadata_spec.rb', line 29
    +              
    # File 'spec/endpoints/files/get_metadata_spec.rb', line 30
     
     folder = @client.("#{path_prefix}/folder")
     
     expect(folder).to be_a(DropboxApi::Metadata::Folder)
    -expect(folder.name).to eq("folder")
    +expect(folder.name).to eq('folder')
    @@ -4772,12 +5297,12 @@

     
     
    -27
     28
    -29
    +29 +30 -
    # File 'spec/endpoints/files/get_metadata_spec.rb', line 29
    +              
    # File 'spec/endpoints/files/get_metadata_spec.rb', line 30
     
     expect {
       @client.("#{path_prefix}/unexisting_folder")
    @@ -4795,21 +5320,69 @@ 

     
     
    -33
     34
    -35
    +35 +36

    -
    # File 'spec/endpoints/files/get_metadata_spec.rb', line 29
    +              
    # File 'spec/endpoints/files/get_metadata_spec.rb', line 30
     
     expect {
    -  @client.("#{path_prefix}/file.txt", :invalid_option => true)
    +  @client.("#{path_prefix}/file.txt", invalid_option: true)
     }.to raise_error ArgumentError
    +
  • + raises an error + + + + + +
    +
    +
    +
    +41
    +42
    +43
    +
    +
    # File 'spec/endpoints/files/get_metadata_spec.rb', line 30
    +
    +expect {
    +  @client.("#{path_prefix}/deleted_file.txt")
    +}.to raise_error(DropboxApi::Errors::NotFoundError)
    +
    +
  • + +
  • + with `:include_deleted`, returns a `File` + + + + + +
    +
    +
    +
    +47
    +48
    +49
    +50
    +
    +
    # File 'spec/endpoints/files/get_metadata_spec.rb', line 30
    +
    +file = @client.("#{path_prefix}/deleted_file.txt", include_deleted: true)
    +
    +expect(file).to be_a(DropboxApi::Metadata::Deleted)
    +expect(file.name).to eq('deleted_file.txt')
    +
    +
  • + @@ -4819,7 +5392,6 @@

     
     
    -29
     30
     31
     32
    @@ -4829,10 +5401,11 @@ 

    36 37 38 -39

    +39 +40

    -
    # File 'lib/dropbox_api/endpoints/files/get_metadata.rb', line 29
    +      
    # File 'lib/dropbox_api/endpoints/files/get_metadata.rb', line 30
     
     add_endpoint :get_metadata do |path, options = {}|
       validate_options([
    @@ -4842,7 +5415,7 @@ 

    ], options) perform_request(options.merge({ - :path => path + path: path })) end

    @@ -4903,18 +5476,18 @@

     
     
    -6
     7
     8
    -9
    +9 +10

    -
    # File 'spec/endpoints/files/get_preview_spec.rb', line 13
    +              
    # File 'spec/endpoints/files/get_preview_spec.rb', line 14
     
    -file = @client.get_preview("/file.docx")
    +file = @client.get_preview('/file.docx')
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("file.docx")
    +expect(file.name).to eq('file.docx')
    @@ -4928,15 +5501,15 @@

     
     
    -13
     14
    -15
    +15 +16

    -
    # File 'spec/endpoints/files/get_preview_spec.rb', line 13
    +              
    # File 'spec/endpoints/files/get_preview_spec.rb', line 14
     
     expect {
    -  @client.get_preview("/unknown_file.jpg")
    +  @client.get_preview('/unknown_file.jpg')
     }.to raise_error(DropboxApi::Errors::NotFoundError)
    @@ -4952,15 +5525,15 @@

     
     
    -13
     14
    -15
    +15 +16

    -
    # File 'lib/dropbox_api/endpoints/files/get_preview.rb', line 13
    +      
    # File 'lib/dropbox_api/endpoints/files/get_preview.rb', line 14
     
     add_endpoint :get_preview do |path, &block|
    -  perform_request({:path => path}, &block)
    +  perform_request({path: path}, &block)
     end
    @@ -5054,19 +5627,19 @@
    -
    # File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 22
    +              
    # File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 23
     
     shared_link = @client
    -  .list_shared_links(:path => "#{path_prefix}/shared_file.txt")
    +  .list_shared_links(path: "#{path_prefix}/shared_file.txt")
       .links
       .first
     result = @client. shared_link.url
    @@ -5085,19 +5658,19 @@ 
    -
    # File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 22
    +              
    # File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 23
     
     shared_link = @client
    -  .list_shared_links(:path => "#{path_prefix}/shared_folder")
    +  .list_shared_links(path: "#{path_prefix}/shared_folder")
       .links
       .first
     result = @client. shared_link.url
    @@ -5116,16 +5689,16 @@ 
    -
    # File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 22
    +              
    # File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 23
     
    -bad_link = "https://www.dropbox.com/sh/abcd/1234?dl=0"
    +bad_link = 'https://www.dropbox.com/sh/abcd/1234?dl=0'
     
     expect {
       @client. bad_link
    @@ -5144,22 +5717,22 @@ 
    -
    # File 'lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb', line 22
    +      
    # File 'lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb', line 23
     
     add_endpoint :get_shared_link_metadata do |preview_link, options = {}|
       validate_options([:path, :link_password], options)
     
       perform_request options.merge(
    -    :url => preview_link
    +    url: preview_link
       )
     end
    @@ -5210,12 +5783,12 @@

     
     
    -11
     12
    -13
    +13 +14

    -
    # File 'lib/dropbox_api/endpoints/users/get_space_usage.rb', line 11
    +      
    # File 'lib/dropbox_api/endpoints/users/get_space_usage.rb', line 12
     
     add_endpoint :get_space_usage do
       perform_request nil
    @@ -5278,18 +5851,18 @@ 
    -
    # File 'spec/endpoints/files/get_temporary_link_spec.rb', line 13
    +              
    # File 'spec/endpoints/files/get_temporary_link_spec.rb', line 14
     
    -result = @client.get_temporary_link "/img.png"
    +result = @client.get_temporary_link '/img.png'
     
     expect(result).to be_a(DropboxApi::Results::GetTemporaryLinkResult)
    -expect(result.file.name).to eq("img.png")
    +expect(result.file.name).to eq('img.png')
    @@ -5303,15 +5876,15 @@
    -
    # File 'spec/endpoints/files/get_temporary_link_spec.rb', line 13
    +              
    # File 'spec/endpoints/files/get_temporary_link_spec.rb', line 14
     
     expect {
    -  @client.get_preview "/unknown_file.jpg"
    +  @client.get_preview '/unknown_file.jpg'
     }.to raise_error(DropboxApi::Errors::NotFoundError)
    @@ -5327,15 +5900,15 @@
    -
    # File 'lib/dropbox_api/endpoints/files/get_temporary_link.rb', line 13
    +      
    # File 'lib/dropbox_api/endpoints/files/get_temporary_link.rb', line 14
     
     add_endpoint :get_temporary_link do |path|
    -  perform_request({:path => path})
    +  perform_request({path: path})
     end
    @@ -5469,18 +6042,18 @@

     
     
    -6
     7
     8
    -9
    +9 +10

    -
    # File 'spec/endpoints/files/get_thumbnail_spec.rb', line 47
    +              
    # File 'spec/endpoints/files/get_thumbnail_spec.rb', line 48
     
    -file = @client.get_thumbnail "/img.png"
    +file = @client.get_thumbnail '/img.png'
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("img.png")
    +expect(file.name).to eq('img.png')
    @@ -5494,15 +6067,15 @@

     
     
    -13
     14
    -15
    +15 +16

    -
    # File 'spec/endpoints/files/get_thumbnail_spec.rb', line 47
    +              
    # File 'spec/endpoints/files/get_thumbnail_spec.rb', line 48
     
     expect {
    -  @client.get_thumbnail "/unknown_file.jpg"
    +  @client.get_thumbnail '/unknown_file.jpg'
     }.to raise_error(DropboxApi::Errors::NotFoundError)
    @@ -5517,15 +6090,15 @@

     
     
    -19
     20
    -21
    +21 +22

    -
    # File 'spec/endpoints/files/get_thumbnail_spec.rb', line 47
    +              
    # File 'spec/endpoints/files/get_thumbnail_spec.rb', line 48
     
     expect {
    -  @client.get_thumbnail "/img.png", :invalid_arg => "value"
    +  @client.get_thumbnail '/img.png', invalid_arg: 'value'
     }.to raise_error(ArgumentError)
    @@ -5541,7 +6114,6 @@

     
     
    -47
     48
     49
     50
    @@ -5549,10 +6121,11 @@ 

    52 53 54 -55

    +55 +56

    -
    # File 'lib/dropbox_api/endpoints/files/get_thumbnail.rb', line 47
    +      
    # File 'lib/dropbox_api/endpoints/files/get_thumbnail.rb', line 48
     
     add_endpoint :get_thumbnail do |path, options = {}, &block|
       validate_options([:format, :size], options)
    @@ -5560,7 +6133,7 @@ 

    options[:size] ||= :w64h64 perform_request(options.merge({ - :path => path + path: path }), &block) end

    @@ -5670,22 +6243,22 @@

     
     
    -8
     9
     10
     11
     12
    -13
    +13 +14

    -
    # File 'spec/endpoints/files/get_thumbnail_batch_spec.rb', line 22
    +              
    # File 'spec/endpoints/files/get_thumbnail_batch_spec.rb', line 23
     
     result = @client.get_thumbnail_batch ["#{path_prefix}/img.png"]
     entry = result.entries.first
     
     expect(entry.).to be_a(DropboxApi::Metadata::File)
     expect(entry.thumbnail).to be_a(String)
    -expect(entry..name).to eq("img.png")
    +expect(entry..name).to eq('img.png')
    @@ -5699,11 +6272,11 @@

     
     
    -17
    -18
    +18 +19

    -
    # File 'spec/endpoints/files/get_thumbnail_batch_spec.rb', line 22
    +              
    # File 'spec/endpoints/files/get_thumbnail_batch_spec.rb', line 23
     
     result = @client.get_thumbnail_batch ["#{path_prefix}/unknown_file.jpg"]
     expect(result.entries.first).to be_a(DropboxApi::Errors::NotFoundError)
    @@ -5720,15 +6293,15 @@

     
     
    -22
     23
    -24
    +24 +25

    -
    # File 'spec/endpoints/files/get_thumbnail_batch_spec.rb', line 22
    +              
    # File 'spec/endpoints/files/get_thumbnail_batch_spec.rb', line 23
     
     expect {
    -  @client.get_thumbnail_batch ["#{path_prefix}/img.png"], :invalid_arg => "value"
    +  @client.get_thumbnail_batch ["#{path_prefix}/img.png"], invalid_arg: 'value'
     }.to raise_error(ArgumentError)
    @@ -5744,17 +6317,17 @@

     
     
    -22
     23
     24
     25
     26
     27
     28
    -29
    +29 +30

    -
    # File 'lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb', line 22
    +      
    # File 'lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb', line 23
     
     add_endpoint :get_thumbnail_batch do |paths, options = {}|
       validate_options([:format, :size, :mode], options)
    @@ -5762,7 +6335,7 @@ 

    options[:size] ||= :w64h64 options[:mode] ||= :strict - perform_request :entries => build_entries_params(paths, options) + perform_request entries: build_entries_params(paths, options) end

    @@ -5929,14 +6502,14 @@

     
     
    -6
     7
    -8
    +8 +9

    -
    # File 'spec/endpoints/sharing/list_file_members_spec.rb', line 36
    +              
    # File 'spec/endpoints/sharing/list_file_members_spec.rb', line 37
     
    -result = @client.list_file_members "1231273663"
    +result = @client.list_file_members '1231273663'
     
     expect(result).to be_a(DropboxApi::Results::SharedFileMembers)
    @@ -5952,14 +6525,14 @@

     
     
    -12
     13
    -14
    +14 +15

    -
    # File 'spec/endpoints/sharing/list_file_members_spec.rb', line 36
    +              
    # File 'spec/endpoints/sharing/list_file_members_spec.rb', line 37
     
    -result = @client.list_file_members "1231273663", [:remove, :make_owner]
    +result = @client.list_file_members '1231273663', [:remove, :make_owner]
     
     expect(result).to be_a(DropboxApi::Results::SharedFileMembers)
    @@ -5976,7 +6549,6 @@

     
     
    -36
     37
     38
     39
    @@ -5984,18 +6556,19 @@ 

    41 42 43 -44

    +44 +45

    -
    # File 'lib/dropbox_api/endpoints/sharing/list_file_members.rb', line 36
    +      
    # File 'lib/dropbox_api/endpoints/sharing/list_file_members.rb', line 37
     
     add_endpoint :list_file_members do |file_id, actions = [], options = {}|
       validate_options([:limit, :include_inherited], options)
       options[:limit] ||= 100
     
       perform_request options.merge({
    -    :file => file_id,
    -    :actions => DropboxApi::Metadata::MemberActionList.new(actions)
    +    file: file_id,
    +    actions: DropboxApi::Metadata::MemberActionList.new(actions)
       })
     end
    @@ -6124,14 +6697,14 @@

     
     
    -7
     8
    -9
    +9 +10

    -
    # File 'spec/endpoints/files/list_folder_spec.rb', line 28
    +              
    # File 'spec/endpoints/files/list_folder_spec.rb', line 29
     
    -result = @client.list_folder ""
    +result = @client.list_folder ''
     
     expect(result).to be_a(DropboxApi::Results::ListFolderResult)
    @@ -6147,15 +6720,15 @@

     
     
    -13
     14
    -15
    +15 +16

    -
    # File 'spec/endpoints/files/list_folder_spec.rb', line 28
    +              
    # File 'spec/endpoints/files/list_folder_spec.rb', line 29
     
     expect {
    -  @client.list_folder "/unexisting_folder"
    +  @client.list_folder '/unexisting_folder'
     }.to raise_error(DropboxApi::Errors::NotFoundError)
    @@ -6170,16 +6743,16 @@

     
     
    -19
     20
     21
     22
    -23
    +23 +24

    -
    # File 'spec/endpoints/files/list_folder_spec.rb', line 28
    +              
    # File 'spec/endpoints/files/list_folder_spec.rb', line 29
     
    -result = @client.list_folder ""
    +result = @client.list_folder ''
     
     result.entries.each do |resource|
       expect(resource).to be_a(DropboxApi::Metadata::Base)
    @@ -6197,24 +6770,24 @@ 

     
     
    -27
     28
     29
     30
     31
     32
    -33
    +33 +34

    -
    # File 'spec/endpoints/files/list_folder_spec.rb', line 28
    +              
    # File 'spec/endpoints/files/list_folder_spec.rb', line 29
     
    -result = @client.list_shared_links(:path => "#{path_prefix}/shared_folder")
    -result = @client.list_folder "", :shared_link => result.links.first.url
    +result = @client.list_shared_links(path: "#{path_prefix}/shared_folder")
    +result = @client.list_folder '', shared_link: result.links.first.url
     
     result.entries.each do |resource|
       expect(resource).to be_a(DropboxApi::Metadata::Base)
     end
    -expect(result.entries.map(&:name).inspect).to include("cow.txt")
    +expect(result.entries.map(&:name).inspect).to include('cow.txt')
    @@ -6228,21 +6801,102 @@

     
     
    -37
     38
    -39
    +39 +40

    -
    # File 'spec/endpoints/files/list_folder_spec.rb', line 28
    +              
    # File 'spec/endpoints/files/list_folder_spec.rb', line 29
     
     expect {
    -  @client.list_folder "/img.png", :invalid_arg => "value"
    +  @client.list_folder '/img.png', invalid_arg: 'value'
     }.to raise_error(ArgumentError)
    +
  • + works with a namespace_id + + + + + +
    +
    +
    +
    +45
    +46
    +
    +
    # File 'spec/endpoints/files/list_folder_spec.rb', line 29
    +
    +@client.namespace_id = 70721710
    +@client.list_folder '/dropbox_api_fixtures'
    +
    +
  • + +
  • + fails with an invalid namespace ID + + + + + +
    +
    +
    +
    +50
    +51
    +52
    +53
    +54
    +
    +
    # File 'spec/endpoints/files/list_folder_spec.rb', line 29
    +
    +@client.namespace_id = 938429923
    +
    +expect do
    +  @client.list_folder '/dropbox_api_fixtures'
    +end.to raise_error(DropboxApi::Errors::HttpError)
    +
    +
  • + +
  • + works if namespace ID is unset + + + + + +
    +
    +
    +
    +58
    +59
    +60
    +61
    +62
    +63
    +64
    +65
    +
    +
    # File 'spec/endpoints/files/list_folder_spec.rb', line 29
    +
    +@client.namespace_id = 70721710
    +
    +# we expect this to use a namespace ID
    +@client.list_folder '/dropbox_api_fixtures'
    +
    +@client.namespace_id = nil
    +# we expect the next not to use any namespace ID
    +@client.list_folder '/dropbox_api_fixtures'
    +
    +
  • + @@ -6252,7 +6906,6 @@

     
     
    -28
     29
     30
     31
    @@ -6270,10 +6923,11 @@ 

    43 44 45 -46

    +46 +47

    -
    # File 'lib/dropbox_api/endpoints/files/list_folder.rb', line 28
    +      
    # File 'lib/dropbox_api/endpoints/files/list_folder.rb', line 29
     
     add_endpoint :list_folder do |path, options = {}|
       validate_options([
    @@ -6291,7 +6945,7 @@ 

    options[:limit] = options[:limit] if options[:limit] perform_request options.merge({ - :path => path + path: path }) end

    @@ -6352,12 +7006,12 @@

     
     
    -14
     15
    -16
    +16 +17

    -
    # File 'spec/endpoints/files/list_folder_continue_spec.rb', line 16
    +              
    # File 'spec/endpoints/files/list_folder_continue_spec.rb', line 17
     
     result = @client.list_folder_continue(@cursor)
     
    @@ -6376,15 +7030,15 @@ 

     
     
    -16
     17
    -18
    +18 +19

    -
    # File 'lib/dropbox_api/endpoints/files/list_folder_continue.rb', line 16
    +      
    # File 'lib/dropbox_api/endpoints/files/list_folder_continue.rb', line 17
     
     add_endpoint :list_folder_continue do |cursor|
    -  perform_request :cursor => cursor
    +  perform_request cursor: cursor
     end
    @@ -6491,15 +7145,15 @@

     
     
    -13
     14
     15
    -16
    +16 +17

    -
    # File 'spec/endpoints/files/list_folder_get_latest_cursor_spec.rb', line 27
    +              
    # File 'spec/endpoints/files/list_folder_get_latest_cursor_spec.rb', line 28
     
    -result = @client.list_folder_get_latest_cursor :path => "/folder"
    +result = @client.list_folder_get_latest_cursor path: '/folder'
     
     expect(result)
       .to be_a(DropboxApi::Results::ListFolderGetLatestCursorResult)
    @@ -6517,7 +7171,6 @@

     
     
    -27
     28
     29
     30
    @@ -6530,10 +7183,11 @@ 

    37 38 39 -40

    +40 +41

    -
    # File 'lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb', line 27
    +      
    # File 'lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb', line 28
     
     add_endpoint :list_folder_get_latest_cursor do |options = {}|
       validate_options([
    @@ -6638,12 +7292,12 @@ 

     
     
    -12
     13
    -14
    +14 +15

    -
    # File 'spec/endpoints/files/list_folder_longpoll_spec.rb', line 24
    +              
    # File 'spec/endpoints/files/list_folder_longpoll_spec.rb', line 25
     
     result = @client.list_folder_longpoll @cursor
     
    @@ -6661,12 +7315,12 @@ 

     
     
    -18
     19
    -20
    - +20 +21

    + -
    # File 'spec/endpoints/files/list_folder_longpoll_spec.rb', line 24
    +              
    # File 'spec/endpoints/files/list_folder_longpoll_spec.rb', line 25
     
     result = @client.list_folder_longpoll @cursor
     
    @@ -6684,15 +7338,15 @@ 

     
     
    -24
     25
    -26
    +26 +27

    -
    # File 'spec/endpoints/files/list_folder_longpoll_spec.rb', line 24
    +              
    # File 'spec/endpoints/files/list_folder_longpoll_spec.rb', line 25
     
     expect {
    -  @client.list_folder_longpoll "I believe in the blerch"
    +  @client.list_folder_longpoll 'I believe in the blerch'
     }.to raise_error DropboxApi::Errors::HttpError
    @@ -6708,7 +7362,6 @@

     
     
    -24
     25
     26
     27
    @@ -6717,10 +7370,11 @@ 

    30 31 32 -33

    +33 +34

    -
    # File 'lib/dropbox_api/endpoints/files/list_folder_longpoll.rb', line 24
    +      
    # File 'lib/dropbox_api/endpoints/files/list_folder_longpoll.rb', line 25
     
     add_endpoint :list_folder_longpoll do |cursor, options = {}|
       validate_options([
    @@ -6729,7 +7383,7 @@ 

    options[:timeout] ||= 30 perform_request options.merge({ - :cursor => cursor + cursor: cursor }) end

    @@ -6876,14 +7530,14 @@

     
     
    -6
     7
    -8
    +8 +9

    -
    # File 'spec/endpoints/sharing/list_folder_members_spec.rb', line 29
    +              
    # File 'spec/endpoints/sharing/list_folder_members_spec.rb', line 30
     
    -result = @client.list_folder_members "1231273663"
    +result = @client.list_folder_members '1231273663'
     
     expect(result).to be_a(DropboxApi::Results::SharedFolderMembers)
    @@ -6899,14 +7553,14 @@

     
     
    -12
     13
    -14
    +14 +15

    -
    # File 'spec/endpoints/sharing/list_folder_members_spec.rb', line 29
    +              
    # File 'spec/endpoints/sharing/list_folder_members_spec.rb', line 30
     
    -result = @client.list_folder_members "1231273663", [:remove, :make_owner]
    +result = @client.list_folder_members '1231273663', [:remove, :make_owner]
     
     expect(result).to be_a(DropboxApi::Results::SharedFolderMembers)
    @@ -6923,7 +7577,6 @@

     
     
    -29
     30
     31
     32
    @@ -6931,18 +7584,19 @@ 

    34 35 36 -37

    +37 +38

    -
    # File 'lib/dropbox_api/endpoints/sharing/list_folder_members.rb', line 29
    +      
    # File 'lib/dropbox_api/endpoints/sharing/list_folder_members.rb', line 30
     
     add_endpoint :list_folder_members do |folder_id, actions = [], options = {}|
       validate_options([:limit], options)
       options[:limit] ||= 100
     
       perform_request options.merge({
    -    :shared_folder_id => folder_id,
    -    :actions => DropboxApi::Metadata::MemberActionList.new(actions)
    +    shared_folder_id: folder_id,
    +    actions: DropboxApi::Metadata::MemberActionList.new(actions)
       })
     end
    @@ -7025,14 +7679,14 @@

     
     
    -6
     7
    -8
    +8 +9

    -
    # File 'spec/endpoints/files/list_revisions_spec.rb', line 15
    +              
    # File 'spec/endpoints/files/list_revisions_spec.rb', line 16
     
    -result = @client.list_revisions "/file.txt"
    +result = @client.list_revisions '/file.txt'
     
     expect(result).to be_a(DropboxApi::Results::ListRevisionsResult)
    @@ -7048,15 +7702,15 @@

     
     
    -12
     13
    -14
    +14 +15

    -
    # File 'spec/endpoints/files/list_revisions_spec.rb', line 15
    +              
    # File 'spec/endpoints/files/list_revisions_spec.rb', line 16
     
     expect {
    -  @client.list_revisions "/unexisting_file"
    +  @client.list_revisions '/unexisting_file'
     }.to raise_error(DropboxApi::Errors::NotFoundError)
    @@ -7071,16 +7725,16 @@

     
     
    -18
     19
     20
     21
    -22
    +22 +23

    -
    # File 'spec/endpoints/files/list_revisions_spec.rb', line 15
    +              
    # File 'spec/endpoints/files/list_revisions_spec.rb', line 16
     
    -result = @client.list_revisions "/file.txt"
    +result = @client.list_revisions '/file.txt'
     
     result.entries.each do |resource|
       expect(resource).to be_a(DropboxApi::Metadata::Base)
    @@ -7098,14 +7752,14 @@ 

     
     
    -26
     27
    -28
    +28 +29

    -
    # File 'spec/endpoints/files/list_revisions_spec.rb', line 15
    +              
    # File 'spec/endpoints/files/list_revisions_spec.rb', line 16
     
    -result = @client.list_revisions "/file.txt"
    +result = @client.list_revisions '/file.txt'
     
     expect(result.is_deleted?).to be_truthy
    @@ -7122,7 +7776,6 @@

     
     
    -15
     16
     17
     18
    @@ -7131,10 +7784,11 @@ 

    21 22 23 -24

    +24 +25

    -
    # File 'lib/dropbox_api/endpoints/files/list_revisions.rb', line 15
    +      
    # File 'lib/dropbox_api/endpoints/files/list_revisions.rb', line 16
     
     add_endpoint :list_revisions do |path, options = {}|
       validate_options([
    @@ -7143,7 +7797,7 @@ 

    options[:limit] ||= 10 perform_request options.merge({ - :path => path + path: path }) end

    @@ -7231,20 +7885,164 @@

     
     
    -13
     14
     15
    -16
    +16 +17

    -
    # File 'spec/endpoints/files/move_spec.rb', line 19
    +              
    # File 'spec/endpoints/files/move_spec.rb', line 20
     
    -file = @client.move("/folder", "/test/folder")
    +file = @client.move('/folder', '/test/folder')
     
     expect(file).to be_a(DropboxApi::Metadata::Folder)
    -expect(file.name).to eq("folder")
    +expect(file.name).to eq('folder')
    @@ -7432,18 +8230,18 @@

     
     
    -20
     21
     22
    -23
    +23 +24

    -
    # File 'spec/endpoints/files/move_spec.rb', line 19
    +              
    # File 'spec/endpoints/files/move_spec.rb', line 20
     
    -file = @client.move("/a.jpg", "/photo.jpg", :autorename => true)
    +file = @client.move('/a.jpg', '/photo.jpg', autorename: true)
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("photo (1).jpg")
    +expect(file.name).to eq('photo (1).jpg')
    @@ -7457,15 +8255,15 @@

     
     
    -27
     28
    -29
    +29 +30

    -
    # File 'spec/endpoints/files/move_spec.rb', line 19
    +              
    # File 'spec/endpoints/files/move_spec.rb', line 20
     
     expect {
    -  @client.move("/z.jpg", "/b.jpg")
    +  @client.move('/z.jpg', '/b.jpg')
     }.to raise_error(DropboxApi::Errors::NotFoundError)
    @@ -7481,7 +8279,6 @@

     
     
    -19
     20
     21
     22
    @@ -7493,10 +8290,11 @@ 

    28 29 30 -31

    +31 +32

    -
    # File 'lib/dropbox_api/endpoints/files/move.rb', line 19
    +      
    # File 'lib/dropbox_api/endpoints/files/move.rb', line 20
     
     add_endpoint :move do |from, to, options = {}|
       # We're not implementing support for the `allow_shared_folder` option
    @@ -7507,13 +8305,75 @@ 

    ], options) perform_request options.merge({ - :from_path => from, - :to_path => to + from_path: from, + to_path: to }) end

    + + +
    +

    + + #namespace_idObject + + + + + +

    + + + + + +
    +
    +
    +
    +29
    +30
    +31
    +
    +
    # File 'lib/dropbox_api/client.rb', line 29
    +
    +def namespace_id
    +  @connection_builder.namespace_id
    +end
    +
    +
    + +
    +

    + + #namespace_id=(value) ⇒ Object + + + + + +

    + + + + + +
    +
    +
    +
    +25
    +26
    +27
    +
    +
    # File 'lib/dropbox_api/client.rb', line 25
    +
    +def namespace_id=(value)
    +  @connection_builder.namespace_id = value
    +end
    +
    @@ -7596,12 +8456,12 @@

     
     
    -7
     8
    -9
    +9 +10

    -
    # File 'spec/endpoints/files/permanently_delete_spec.rb', line 20
    +              
    # File 'spec/endpoints/files/permanently_delete_spec.rb', line 21
     
     expect {
       @client.permanently_delete "#{path_prefix}/file.txt"
    @@ -7620,22 +8480,22 @@ 

     
     
    -20
     21
     22
     23
     24
     25
    -26
    +26 +27

    -
    # File 'lib/dropbox_api/endpoints/files/permanently_delete.rb', line 20
    +      
    # File 'lib/dropbox_api/endpoints/files/permanently_delete.rb', line 21
     
     add_endpoint :permanently_delete do |path, options = {}|
       validate_options([:parent_rev], options)
     
       perform_request options.merge({
    -    :path => path
    +    path: path
       })
     end
    @@ -7709,14 +8569,14 @@

     
     
    -6
     7
    -8
    +8 +9

    -
    # File 'spec/endpoints/files/restore_spec.rb', line 12
    +              
    # File 'spec/endpoints/files/restore_spec.rb', line 13
     
    -file = @client.restore("/file.txt", "1a6a24061bdd")
    +file = @client.restore('/file.txt', '1a6a24061bdd')
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    @@ -7732,15 +8592,15 @@

     
     
    -13
     14
    -15
    +15 +16

    -
    # File 'spec/endpoints/files/restore_spec.rb', line 12
    +              
    # File 'spec/endpoints/files/restore_spec.rb', line 13
     
     expect {
    -  file = @client.restore("/file.txt", "1a6a24061000")
    +  file = @client.restore('/file.txt', '1a6a24061000')
     }.to raise_error(DropboxApi::Errors::InvalidRevisionError)
    @@ -7756,20 +8616,20 @@

     
     
    -12
     13
     14
     15
     16
    -17
    +17 +18

    -
    # File 'lib/dropbox_api/endpoints/files/restore.rb', line 12
    +      
    # File 'lib/dropbox_api/endpoints/files/restore.rb', line 13
     
     add_endpoint :restore do |path, rev|
       perform_request({
    -    :path => path,
    -    :rev => rev
    +    path: path,
    +    rev: rev
       })
     end
    @@ -7821,24 +8681,119 @@

     
     
    -12
     13
    -14
    +14 +15

    -
    # File 'spec/endpoints/files/save_url_spec.rb', line 15
    +              
    # File 'spec/endpoints/files/save_url_spec.rb', line 16
     
    -result = @client.save_url("/photo_2.jpg", "https://static1.squarespace.com/static/518aa4bee4b050d373a7e8a2/t/558add71e4b062927077adc6/1435164035794/photo-1427348693976-99e4aca06bb9.jpg")
    +result = @client.save_url('/photo_2.jpg', 'https://static1.squarespace.com/static/518aa4bee4b050d373a7e8a2/t/558add71e4b062927077adc6/1435164035794/photo-1427348693976-99e4aca06bb9.jpg')
     
    -expect(result.async_job_id).to eq("VofXAX8DO1sAAAAAAAAD_w")
    +expect(result.async_job_id).to eq('VofXAX8DO1sAAAAAAAAD_w')
    @@ -7977,15 +8932,15 @@

     
     
    -18
     19
    -20
    +20 +21

    -
    # File 'spec/endpoints/files/save_url_spec.rb', line 15
    +              
    # File 'spec/endpoints/files/save_url_spec.rb', line 16
     
     expect {
    -  file = @client.save_url("/photo_3.jpg", "1a6a24061000")
    +  file = @client.save_url('/photo_3.jpg', '1a6a24061000')
     }.to raise_error(DropboxApi::Errors::InvalidUrlError)
    @@ -8001,20 +8956,20 @@

     
     
    -15
     16
     17
     18
     19
    -20
    +20 +21

    -
    # File 'lib/dropbox_api/endpoints/files/save_url.rb', line 15
    +      
    # File 'lib/dropbox_api/endpoints/files/save_url.rb', line 16
     
     add_endpoint :save_url do |path, url|
       perform_request({
    -    :path => path,
    -    :url => url
    +    path: path,
    +    url: url
       })
     end
    @@ -8091,14 +9046,14 @@

     
     
    -6
     7
    -8
    +8 +9

    -
    # File 'spec/endpoints/files/save_url_check_job_status_spec.rb', line 13
    +              
    # File 'spec/endpoints/files/save_url_check_job_status_spec.rb', line 14
     
    -result = @client.save_url_check_job_status "VofXAX8DO1sAAAAAAAAD_Q"
    +result = @client.save_url_check_job_status 'VofXAX8DO1sAAAAAAAAD_Q'
     
     expect(result).to be_a(DropboxApi::Metadata::File)
    @@ -8114,15 +9069,15 @@

     
     
    -12
     13
     14
    -15
    +15 +16

    -
    # File 'spec/endpoints/files/save_url_check_job_status_spec.rb', line 13
    +              
    # File 'spec/endpoints/files/save_url_check_job_status_spec.rb', line 14
     
    -save_url_result = @client.save_url("/file.zip", "http://ipv4.download.thinkbroadband.com/1GB.zip")
    +save_url_result = @client.save_url('/file.zip', 'http://ipv4.download.thinkbroadband.com/1GB.zip')
     status = @client.save_url_check_job_status save_url_result.async_job_id
     
     expect(status).to eq(:in_progress)
    @@ -8139,16 +9094,16 @@

     
     
    -19
     20
     21
     22
    -23
    +23 +24

    -
    # File 'spec/endpoints/files/save_url_check_job_status_spec.rb', line 13
    +              
    # File 'spec/endpoints/files/save_url_check_job_status_spec.rb', line 14
     
    -save_url_result = @client.save_url("/missing_file.zip", "http://ipv4.download.thinkbroadband.com/not_found.zip")
    +save_url_result = @client.save_url('/missing_file.zip', 'http://ipv4.download.thinkbroadband.com/not_found.zip')
     # sleep 30 # We may need to wait until job completes to get its failure
     status = @client.save_url_check_job_status save_url_result.async_job_id
     
    @@ -8167,19 +9122,195 @@ 

     
     
    -13
     14
     15
     16
    -17
    +17 +18

    + + +
    # File 'lib/dropbox_api/endpoints/files/save_url_check_job_status.rb', line 14
    +
    +add_endpoint :save_url_check_job_status do |job_id|
    +  perform_request({
    +    async_job_id: job_id
    +  })
    +end
    + + + + + +
    +

    + + #search(query, options = nil, match_field_options = nil) ⇒ Object + + + + + +

    +
    +

    Searches for files and folders.

    + +

    Note: Recent changes may not immediately be reflected in search results +due to a short delay in indexing.

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + query + + + (String) + + + + — +

      The string to search for. May match across +multiple fields based on the request arguments.

      +
      + +
    • + +
    • + + options + + + (DropboxApi::Metadata::SearchOptions) + + + (defaults to: nil) + + + — +

      Options for more +targeted search results. This field is optional.

      +
      + +
    • + +
    • + + match_field_options + + + (DropboxApi::Metadata::SearchMatchFieldOptions) + + + (defaults to: nil) + + + — +

      Options for search results match fields. This field is optional.

      +
      + +
    • + +
    + + +
    +
    +

    Specifications:

    +
      + +
    • + returns a list of matching results + + + + + +
      +
      +
      +
      +7
      +8
      +9
      +10
      +11
      +12
      +
      +
      # File 'spec/endpoints/files/search_spec.rb', line 22
      +
      +result = @client.search('findable_file')
      +
      +expect(result).to be_a(DropboxApi::Results::SearchV2Result)
      +match = result.matches.first
      +expect(match.resource.name).to eq('findable_file.txt')
      +expect(match.match_type).to eq(:filename)
      +
      +
    • + +
    • + raises an error if the file can't be found + + + + + +
      +
      +
      +
      +16
      +17
      +18
      +19
      +20
      +21
      +
      +
      # File 'spec/endpoints/files/search_spec.rb', line 22
      +
      +options = DropboxApi::Metadata::SearchOptions.new(
      +  { 'path' => '/bad_folder' }
      +)
      +
      +result = @client.search('/image.png', options)
      +expect(result.matches).to be_empty
      +
      +
    • + +
    +
    + + + + @@ -8187,9 +9318,9 @@

    -

    +

    - #search(query, path = "", options = {}) ⇒ Object + #search_continue(cursor) ⇒ Object @@ -8197,10 +9328,7 @@

    -

    Searches for files and folders.

    - -

    Note: Recent changes may not immediately be reflected in search results -due to a short delay in indexing.

    +

    search:2. Used to fetch the next page of results.

    @@ -8211,93 +9339,21 @@

  • - query - - - (String) - - - - — -

    The string to search for. The search string is -split on spaces into multiple tokens. For file name searching, the last -token is used for prefix matching (i.e. "bat c" matches "bat cave" but -not "batman car").

    -
    - -
  • - -
  • - - path + cursor (String) - (defaults to: "") - — -

    The path in the user's Dropbox to search.

    +

    The cursor returned by your last call to

  • - - - - - - - -

    Options Hash (options):

    -
      - -
    • - start - (Numeric) - - - - - —

      The starting index within the search -results (used for paging). The default for this field is 0.

      -
      - -
    • - -
    • - max_results - (Numeric) - - - - - —

      The maximum number of search -results to return. The default for this field is 100.

      -
      - -
    • - -
    • - mode - (:filename, :filename_and_content, :deleted_filename) - - - - - —

      The search mode. Note that searching file content is only -available for Dropbox Business accounts. The default is filename.

      -
      - -
    • - -
    - -

    @@ -8305,50 +9361,23 @@

    • - returns a list of matching results -

    +
    +
    +
    +22
    +23
    +24
    +25
    +26
    +27
    +28
    +29
    +30
    -
    # File 'lib/dropbox_api/endpoints/files/save_url_check_job_status.rb', line 13
    +      
    # File 'lib/dropbox_api/endpoints/files/search.rb', line 22
     
    -add_endpoint :save_url_check_job_status do |job_id|
    -  perform_request({
    -    :async_job_id => job_id
    -  })
    +add_endpoint :search do |query, options = nil, match_field_options = nil|
    +  params = { query: query }
    +
    +  params[:options] = options.to_hash unless options.nil?
    +
    +  params[:match_field_options] = match_field_options.to_hash unless match_field_options.nil?
    +
    +  perform_request(params)
     end
    - - - - -
    -
    -
    -
    -6
    -7
    -8
    -9
    -10
    -
    -
    # File 'spec/endpoints/files/search_spec.rb', line 27
    -
    -result = @client.search("image.png")
    -
    -expect(result).to be_a(DropboxApi::Results::SearchResult)
    -file = result.matches.first.resource
    -expect(file.name).to eq("image.png")
    -
    - - -
  • - raises an error if the file can't be found + returns a SearchResult
     
     
    -14
     15
    -16
    +16 +17
    -
    # File 'spec/endpoints/files/search_spec.rb', line 27
    +              
    # File 'spec/endpoints/files/search_continue_spec.rb', line 19
     
    -expect {
    -  @client.search("/image.png", "/bad_folder")
    -}.to raise_error(DropboxApi::Errors::NotFoundError)
    +result = @client.search_continue(@cursor) + +expect(result).to be_a(DropboxApi::Results::SearchV2Result)
    @@ -8363,39 +9392,15 @@

     
     
    -27
    -28
    -29
    -30
    -31
    -32
    -33
    -34
    -35
    -36
    -37
    -38
    -39
    -40
    -41
    +19 +20 +21

  • -
    # File 'lib/dropbox_api/endpoints/files/search.rb', line 27
    -
    -add_endpoint :search do |query, path = "", options = {}|
    -  validate_options([
    -    :start,
    -    :max_results,
    -    :mode
    -  ], options)
    -  options[:start] ||= 0
    -  options[:max_results] ||= 100
    -  options[:mode] ||= :filename
    +      
    # File 'lib/dropbox_api/endpoints/files/search_continue.rb', line 19
     
    -  perform_request options.merge({
    -    :query => query,
    -    :path => path
    -  })
    +add_endpoint :search_continue do |cursor|
    +  perform_request cursor: cursor
     end
    @@ -8547,14 +9552,14 @@

     
     
    -6
     7
    -8
    +8 +9

    -
    # File 'spec/endpoints/sharing/share_folder_spec.rb', line 36
    +              
    # File 'spec/endpoints/sharing/share_folder_spec.rb', line 37
     
    -folder = @client.share_folder("/folder_k")
    +folder = @client.share_folder('/folder_k')
     
     expect(folder).to be_a(DropboxApi::Metadata::SharedFolder)
    @@ -8570,14 +9575,14 @@

     
     
    -12
     13
    -14
    +14 +15

    -
    # File 'spec/endpoints/sharing/share_folder_spec.rb', line 36
    +              
    # File 'spec/endpoints/sharing/share_folder_spec.rb', line 37
     
    -folder = @client.share_folder("/already_shared")
    +folder = @client.share_folder('/already_shared')
     
     expect(folder).to be_a(DropboxApi::Metadata::SharedFolder)
    @@ -8593,18 +9598,18 @@

     
     
    -18
     19
     20
    -21
    +21 +22

    -
    # File 'spec/endpoints/sharing/share_folder_spec.rb', line 36
    +              
    # File 'spec/endpoints/sharing/share_folder_spec.rb', line 37
     
    -folder = @client.share_folder("/folder_k")
    +folder = @client.share_folder('/folder_k')
     
     expect(folder.shared_folder_id.to_s)
    -  .to eq("1236414195")
    + .to eq('1236414195')
    @@ -8619,7 +9624,6 @@

     
     
    -36
     37
     38
     39
    @@ -8638,10 +9642,11 @@ 

    52 53 54 -55

    +55 +56

    -
    # File 'lib/dropbox_api/endpoints/sharing/share_folder.rb', line 36
    +      
    # File 'lib/dropbox_api/endpoints/sharing/share_folder.rb', line 37
     
     add_endpoint :share_folder do |path, options = {}|
       validate_options([
    @@ -8657,7 +9662,7 @@ 

    begin perform_request options.merge({ - :path => path + path: path }) rescue DropboxApi::Errors::AlreadySharedError => error error.shared_folder @@ -8700,10 +9705,10 @@

     
     
    -6
    +7

    -
    # File 'spec/endpoints/auth/token_revoke_spec.rb', line 10
    +              
    # File 'spec/endpoints/auth/token_revoke_spec.rb', line 11
     
      = @client.token_revoke
    @@ -8720,12 +9725,12 @@

     
     
    -10
     11
    -12
    +12 +13

    -
    # File 'lib/dropbox_api/endpoints/auth/token_revoke.rb', line 10
    +      
    # File 'lib/dropbox_api/endpoints/auth/token_revoke.rb', line 11
     
     add_endpoint :token_revoke do
       perform_request(nil)
    @@ -8788,12 +9793,12 @@ 

     
     
    -6
    +7

    -
    # File 'spec/endpoints/sharing/unshare_file_spec.rb', line 13
    +              
    # File 'spec/endpoints/sharing/unshare_file_spec.rb', line 14
     
    -file = @client.unshare_file("id:xyz123")
    +file = @client.unshare_file('id:xyz123')
    @@ -8807,15 +9812,15 @@

     
     
    -12
     13
    -14
    +14 +15

    -
    # File 'spec/endpoints/sharing/unshare_file_spec.rb', line 13
    +              
    # File 'spec/endpoints/sharing/unshare_file_spec.rb', line 14
     
     expect {
    -  @client.unshare_file("id:xyz123")
    +  @client.unshare_file('id:xyz123')
     }.to raise_error(DropboxApi::Errors::NoPermissionError)
    @@ -8830,15 +9835,15 @@

     
     
    -18
     19
    -20
    +20 +21

    -
    # File 'spec/endpoints/sharing/unshare_file_spec.rb', line 13
    +              
    # File 'spec/endpoints/sharing/unshare_file_spec.rb', line 14
     
     expect {
    -  @client.unshare_file("id:xyz123")
    +  @client.unshare_file('id:xyz123')
     }.to raise_error(DropboxApi::Errors::EmailUnverifiedError)
    @@ -8854,18 +9859,18 @@

     
     
    -13
     14
     15
     16
    -17
    +17 +18

    -
    # File 'lib/dropbox_api/endpoints/sharing/unshare_file.rb', line 13
    +      
    # File 'lib/dropbox_api/endpoints/sharing/unshare_file.rb', line 14
     
     add_endpoint :unshare_file do |file|
       perform_request({
    -    :file => file
    +    file: file
       })
     end
    @@ -9045,18 +10050,18 @@

     
     
    -7
     8
     9
    -10
    +10 +11

    -
    # File 'spec/endpoints/files/upload_spec.rb', line 49
    +              
    # File 'spec/endpoints/files/upload_spec.rb', line 50
     
    -file = @client.upload("#{path_prefix}/file.txt", "Hello Dropbox!")
    +file = @client.upload("#{path_prefix}/file.txt", 'Hello Dropbox!')
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("file.txt")
    +expect(file.name).to eq('file.txt')
    @@ -9070,22 +10075,22 @@

     
     
    -14
     15
     16
     17
     18
    -19
    +19 +20

    -
    # File 'spec/endpoints/files/upload_spec.rb', line 49
    +              
    # File 'spec/endpoints/files/upload_spec.rb', line 50
     
    -content = File.open(File.join(DropboxScaffoldBuilder.fixtures_path, "file.txt"))
    +content = File.open(File.join(DropboxScaffoldBuilder.fixtures_path, 'file.txt'))
     file = @client.upload("#{path_prefix}/file_io.txt", content)
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("file_io.txt")
    -expect(file.content_hash).to eq("709a5cf259366d6ca6b2fa4d3b53c02f5ce2b2764e9d580711e3ffd24d79f5e9")
    +expect(file.name).to eq('file_io.txt') +expect(file.content_hash).to eq('709a5cf259366d6ca6b2fa4d3b53c02f5ce2b2764e9d580711e3ffd24d79f5e9')
    @@ -9099,24 +10104,24 @@

     
     
    -23
     24
     25
     26
     27
     28
    -29
    +29 +30

    -
    # File 'spec/endpoints/files/upload_spec.rb', line 49
    +              
    # File 'spec/endpoints/files/upload_spec.rb', line 50
     
    -file = @client.upload("#{path_prefix}/file.txt", "Hola Dropbox!", {
    -  :autorename => true,
    -  :mode => :add
    +file = @client.upload("#{path_prefix}/file.txt", 'Hola Dropbox!', {
    +  autorename: true,
    +  mode: :add
     })
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("file (1).txt")
    +expect(file.name).to eq('file (1).txt')
    @@ -9130,24 +10135,24 @@

     
     
    -33
     34
     35
     36
     37
     38
    -39
    +39 +40

    -
    # File 'spec/endpoints/files/upload_spec.rb', line 49
    +              
    # File 'spec/endpoints/files/upload_spec.rb', line 50
     
    -file = @client.upload("#{path_prefix}/file.txt", "Hola Dropbox!", {
    -  :autorename => true,
    -  :mode => :overwrite
    +file = @client.upload("#{path_prefix}/file.txt", 'Hola Dropbox!', {
    +  autorename: true,
    +  mode: :overwrite
     })
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("file.txt")
    +expect(file.name).to eq('file.txt')
    @@ -9161,26 +10166,26 @@

     
     
    -43
     44
     45
     46
     47
     48
     49
    -50
    +50 +51

    -
    # File 'spec/endpoints/files/upload_spec.rb', line 49
    +              
    # File 'spec/endpoints/files/upload_spec.rb', line 50
     
     rev = @client.("#{path_prefix}/file.txt").rev
    -file = @client.upload("#{path_prefix}/file.txt", "Hallo Dropbox!", {
    -  :autorename => true,
    -  :mode => DropboxApi::Metadata::WriteMode.new(:update, rev)
    +file = @client.upload("#{path_prefix}/file.txt", 'Hallo Dropbox!', {
    +  autorename: true,
    +  mode: DropboxApi::Metadata::WriteMode.new(:update, rev)
     })
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("file.txt")
    +expect(file.name).to eq('file.txt')
    @@ -9194,7 +10199,6 @@

     
     
    -54
     55
     56
     57
    @@ -9202,25 +10206,116 @@ 

    59 60 61 -62

    +62 +63 -
    # File 'spec/endpoints/files/upload_spec.rb', line 49
    +              
    # File 'spec/endpoints/files/upload_spec.rb', line 50
     
     modified_at = Time.utc 2016, 12, 25, 12, 0
     
    -file = @client.upload("#{path_prefix}/another_file.txt", "Our country is a mess!", {
    -  :client_modified => modified_at
    +file = @client.upload("#{path_prefix}/another_file.txt", 'Our country is a mess!', {
    +  client_modified: modified_at
     })
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("another_file.txt")
    +expect(file.name).to eq('another_file.txt')
     expect(file.client_modified).to eq(modified_at)
    +
  • + raises a DropboxApi::Errors::TooManyWriteOperations exception + + + + + +
    +
    +
    +
    +68
    +69
    +70
    +71
    +72
    +73
    +74
    +75
    +76
    +77
    +78
    +79
    +80
    +
    +
    # File 'spec/endpoints/files/upload_spec.rb', line 50
    +
    +errors = []
    +
    +15.times.map do |n|
    +  Thread.new do
    +    begin
    +      @client.upload("#{path_prefix}/file_#{n}.txt", 'Hello Dropbox!')
    +    rescue DropboxApi::Errors::TooManyWriteOperationsError => e
    +      errors << e
    +    end
    +  end
    +end.each(&:join)
    +
    +expect(errors.any?).to be_truthy
    +
    +
  • + +
  • + raises an exception with info to retry + + + + + +
    +
    +
    +
    +84
    +85
    +86
    +87
    +88
    +89
    +90
    +91
    +92
    +93
    +94
    +95
    +96
    +97
    +98
    +
    +
    # File 'spec/endpoints/files/upload_spec.rb', line 50
    +
    +errors = []
    +
    +15.times.map do |n|
    +  Thread.new do
    +    begin
    +      @client.upload("#{path_prefix}/file_#{n}.txt", 'Hello Dropbox!')
    +    rescue DropboxApi::Errors::TooManyWriteOperationsError => e
    +      errors << e
    +    end
    +  end
    +end.each(&:join)
    +
    +errors.each do |error|
    +  expect(error.retry_after).to be_a(Numeric)
    +end
    +
    +
  • +
  • uploads a file @@ -9229,18 +10324,18 @@

     
     
    -7
     8
     9
    -10
    +10 +11

    -
    # File 'spec/endpoints/virutal/upload_by_chunks_spec.rb', line 49
    +              
    # File 'spec/endpoints/virtual/upload_by_chunks_spec.rb', line 50
     
    -file = @client.upload_by_chunks("#{path_prefix}/file.txt", "Hello Dropbox!")
    +file = @client.upload_by_chunks("#{path_prefix}/file.txt", 'Hello Dropbox!')
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("file.txt")
    +expect(file.name).to eq('file.txt')
    @@ -9254,22 +10349,22 @@

     
     
    -14
     15
     16
     17
     18
    -19
    +19 +20

  • -
    # File 'spec/endpoints/virutal/upload_by_chunks_spec.rb', line 49
    +              
    # File 'spec/endpoints/virtual/upload_by_chunks_spec.rb', line 50
     
    -content = File.open(File.join(DropboxScaffoldBuilder.fixtures_path, "file.txt"))
    +content = File.open(File.join(DropboxScaffoldBuilder.fixtures_path, 'file.txt'))
     file = @client.upload_by_chunks("#{path_prefix}/file_io.txt", content)
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("file_io.txt")
    -expect(file.content_hash).to eq("709a5cf259366d6ca6b2fa4d3b53c02f5ce2b2764e9d580711e3ffd24d79f5e9")
    +expect(file.name).to eq('file_io.txt') +expect(file.content_hash).to eq('709a5cf259366d6ca6b2fa4d3b53c02f5ce2b2764e9d580711e3ffd24d79f5e9')
    @@ -9283,24 +10378,24 @@

     
     
    -23
     24
     25
     26
     27
     28
    -29
    +29 +30 -
    # File 'spec/endpoints/virutal/upload_by_chunks_spec.rb', line 49
    +              
    # File 'spec/endpoints/virtual/upload_by_chunks_spec.rb', line 50
     
    -file = @client.upload_by_chunks("#{path_prefix}/file.txt", "Hola Dropbox!", {
    -  :autorename => true,
    -  :mode => :add
    +file = @client.upload_by_chunks("#{path_prefix}/file.txt", 'Hola Dropbox!', {
    +  autorename: true,
    +  mode: :add
     })
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("file (1).txt")
    +expect(file.name).to eq('file (1).txt')
    @@ -9315,7 +10410,6 @@

     
     
    -49
     50
     51
     52
    @@ -9326,10 +10420,11 @@ 

    57 58 59 -60

    +60 +61 -
    # File 'lib/dropbox_api/endpoints/files/upload.rb', line 49
    +      
    # File 'lib/dropbox_api/endpoints/files/upload.rb', line 50
     
     add_endpoint :upload do |path, content, options = {}|
       validate_options([
    @@ -9537,17 +10632,17 @@ 

     
     
    -40
     41
     42
     43
     44
     45
     46
    -47
    +47 +48

    -
    # File 'lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb', line 40
    +      
    # File 'lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb', line 41
     
     def upload_by_chunks(path, content, options = {})
       content = StringIO.new(content) if content.is_a?(String)
    @@ -9674,7 +10769,6 @@ 

     
     
    -7
     8
     9
     10
    @@ -9685,10 +10779,11 @@ 

    15 16 17 -18

    +18 +19

    -
    # File 'spec/endpoints/files/upload_session_append_v2_spec.rb', line 38
    +              
    # File 'spec/endpoints/files/upload_session_append_v2_spec.rb', line 39
     
     chunks = ['123456789', 'Olá Dropbox!']
     
    @@ -9715,25 +10810,25 @@ 

     
     
    -22
     23
     24
     25
     26
     27
     28
    -29
    +29 +30

    -
    # File 'spec/endpoints/files/upload_session_append_v2_spec.rb', line 38
    +              
    # File 'spec/endpoints/files/upload_session_append_v2_spec.rb', line 39
     
     cursor = DropboxApi::Metadata::UploadSessionCursor.new({
    -  "session_id" => "INVALID_CURSOR",
    -  "offset" => 0
    +  'session_id' => 'INVALID_CURSOR',
    +  'offset' => 0
     })
     
     expect {
    -  @client.upload_session_append_v2(cursor, "Hello Dropbox!")
    +  @client.upload_session_append_v2(cursor, 'Hello Dropbox!')
     }.to raise_error(DropboxApi::Errors::NotFoundError)
    @@ -9748,7 +10843,6 @@

     
     
    -33
     34
     35
     36
    @@ -9757,12 +10851,13 @@ 

    39 40 41 -42

    +42 +43

    -
    # File 'spec/endpoints/files/upload_session_append_v2_spec.rb', line 38
    +              
    # File 'spec/endpoints/files/upload_session_append_v2_spec.rb', line 39
     
    -chunk = "123456789"
    +chunk = '123456789'
     
     cursor = @client.upload_session_start(chunk)
     
    @@ -9770,7 +10865,7 @@ 

    cursor.instance_variable_set :@offset, 42 expect { - @client.upload_session_append_v2(cursor, "Hello Dropbox!") + @client.upload_session_append_v2(cursor, 'Hello Dropbox!') }.to raise_error(DropboxApi::Errors::UploadSessionOffsetError)

    @@ -9786,7 +10881,6 @@

     
     
    -38
     39
     40
     41
    @@ -9796,10 +10890,11 @@ 

    45 46 47 -48

    +48 +49

    -
    # File 'lib/dropbox_api/endpoints/files/upload_session_append_v2.rb', line 38
    +      
    # File 'lib/dropbox_api/endpoints/files/upload_session_append_v2.rb', line 39
     
     add_endpoint :upload_session_append_v2 do |cursor, content, options = {}|
       validate_options([
    @@ -9807,7 +10902,7 @@ 

    ], options) perform_request(options.merge({ - :cursor => cursor.to_hash + cursor: cursor.to_hash }), content) cursor.offset += content.bytesize @@ -9890,7 +10985,6 @@

     
     
    -6
     7
     8
     9
    @@ -9899,21 +10993,22 @@ 

    12 13 14 -15

    +15 +16

    -
    # File 'spec/endpoints/files/upload_session_finish_spec.rb', line 21
    +              
    # File 'spec/endpoints/files/upload_session_finish_spec.rb', line 22
     
    -cursor = @client.upload_session_start("Hello Dropbox!")
    +cursor = @client.upload_session_start('Hello Dropbox!')
     commit = DropboxApi::Metadata::CommitInfo.new({
    -  "path" => "/Homework/math/Matrices.txt",
    -  "mode" => :add
    +  'path' => '/Homework/math/Matrices.txt',
    +  'mode' => :add
     })
     
     file = @client.upload_session_finish(cursor, commit)
     
     expect(file).to be_a(DropboxApi::Metadata::File)
    -expect(file.name).to eq("Matrices.txt")
    +expect(file.name).to eq('Matrices.txt')
    @@ -9928,20 +11023,20 @@

     
     
    -21
     22
     23
     24
     25
    -26
    +26 +27

    -
    # File 'lib/dropbox_api/endpoints/files/upload_session_finish.rb', line 21
    +      
    # File 'lib/dropbox_api/endpoints/files/upload_session_finish.rb', line 22
     
     add_endpoint :upload_session_finish do |cursor, commit, content = nil|
       perform_request({
    -    :cursor => cursor.to_hash,
    -    :commit => commit.to_hash
    +    cursor: cursor.to_hash,
    +    commit: commit.to_hash
       }, content)
     end
    @@ -10032,18 +11127,18 @@

     
     
    -6
     7
     8
    -9
    +9 +10

    -
    # File 'spec/endpoints/files/upload_session_start_spec.rb', line 25
    +              
    # File 'spec/endpoints/files/upload_session_start_spec.rb', line 26
     
    -cursor = @client.upload_session_start("Hello Dropbox!")
    +cursor = @client.upload_session_start('Hello Dropbox!')
     
     expect(cursor).to be_a(DropboxApi::Metadata::UploadSessionCursor)
    -expect(cursor.session_id).to eq("AAAAAAAMOCK_SESSION_ID")
    +expect(cursor.session_id).to eq('AAAAAAAMOCK_SESSION_ID')
    @@ -10058,7 +11153,6 @@

     
     
    -25
     26
     27
     28
    @@ -10069,10 +11163,11 @@ 

    33 34 35 -36

    +36 +37

    -
    # File 'lib/dropbox_api/endpoints/files/upload_session_start.rb', line 25
    +      
    # File 'lib/dropbox_api/endpoints/files/upload_session_start.rb', line 26
     
     add_endpoint :upload_session_start do |content, options = {}|
       validate_options([
    @@ -10082,8 +11177,8 @@ 

    session = perform_request(options, content) DropboxApi::Metadata::UploadSessionCursor.new({ - "session_id" => session.session_id, - "offset" => content.bytesize + 'session_id' => session.session_id, + 'offset' => content.bytesize }) end

    @@ -10096,9 +11191,9 @@

    diff --git a/docs/DropboxApi/ConnectionBuilder.html b/docs/DropboxApi/ConnectionBuilder.html index e7c53a45..281ddccf 100644 --- a/docs/DropboxApi/ConnectionBuilder.html +++ b/docs/DropboxApi/ConnectionBuilder.html @@ -6,15 +6,15 @@ Class: DropboxApi::ConnectionBuilder - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -103,6 +103,37 @@ +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #namespace_id ⇒ Object + + + + + + + + + + + + + + + + +

      Returns the value of attribute namespace_id.

      +
      + +
    • + + +
    + @@ -139,7 +170,29 @@

  • - #initialize(oauth_bearer) ⇒ ConnectionBuilder + #can_refresh_access_token? ⇒ Boolean + + + + + + + + + + + + + +
    + +
  • + + +
  • + + + #initialize(oauth_bearer = nil, access_token: nil, on_token_refreshed: nil) ⇒ ConnectionBuilder @@ -178,6 +231,28 @@

    +
    + +

  • + + +
  • + + + #refresh_access_token ⇒ Object + + + + + + + + + + + + +
  • @@ -192,7 +267,7 @@

    Constructor Details

    - #initialize(oauth_bearer) ⇒ ConnectionBuilder + #initialize(oauth_bearer = nil, access_token: nil, on_token_refreshed: nil) ⇒ ConnectionBuilder @@ -200,7 +275,7 @@

    -

    Returns a new instance of ConnectionBuilder

    +

    Returns a new instance of ConnectionBuilder.

    @@ -215,15 +290,37 @@

     
     
    -3
    -4
    -5
    +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19

    -
    # File 'lib/dropbox_api/connection_builder.rb', line 3
    +      
    # File 'lib/dropbox_api/connection_builder.rb', line 6
     
    -def initialize(oauth_bearer)
    -  @oauth_bearer = oauth_bearer
    +def initialize(oauth_bearer = nil, access_token: nil, on_token_refreshed: nil)
    +  if access_token
    +    if !access_token.is_a?(OAuth2::AccessToken)
    +      raise ArgumentError, "access_token should be an OAuth2::AccessToken"
    +    end
    +
    +    @access_token = access_token
    +    @on_token_refreshed = on_token_refreshed
    +  elsif oauth_bearer
    +    @oauth_bearer = oauth_bearer
    +  else
    +    raise ArgumentError, "Either oauth_bearer or access_token should be set"
    +  end
     end
    @@ -232,6 +329,54 @@

    +
    +

    Instance Attribute Details

    + + + +
    +

    + + #namespace_idObject + + + + + +

    +
    +

    Returns the value of attribute namespace_id.

    + + +
    +
    +
    + + +
    + + + + + +
    +
    +
    +
    +4
    +5
    +6
    +
    +
    # File 'lib/dropbox_api/connection_builder.rb', line 4
    +
    +def namespace_id
    +  @namespace_id
    +end
    +
    +
    + +
    +

    Instance Method Details

    @@ -253,24 +398,28 @@

     
     
    -11
    -12
    -13
    -14
    -15
    -16
    -17
    -18
    -19
    +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54

    -
    # File 'lib/dropbox_api/connection_builder.rb', line 11
    +      
    # File 'lib/dropbox_api/connection_builder.rb', line 44
     
     def build(url)
       Faraday.new(url) do |connection|
    +    connection.use DropboxApi::MiddleWare::PathRoot, {
    +      namespace_id: self.namespace_id
    +    }
         middleware.apply(connection) do
    -      connection.authorization :Bearer, @oauth_bearer
    -
    +      connection.authorization :Bearer, bearer
           yield connection
         end
       end
    @@ -278,6 +427,59 @@ 

    + + +
    +

    + + #can_refresh_access_token?Boolean + + + + + +

    +
    + + +
    +
    +
    + +

    Returns:

    +
      + +
    • + + + (Boolean) + + + +
    • + +
    + +
    + + + + + +
    +
    +
    +
    +25
    +26
    +27
    +
    +
    # File 'lib/dropbox_api/connection_builder.rb', line 25
    +
    +def can_refresh_access_token?
    +  @access_token && @access_token.refresh_token
    +end
    +
    @@ -296,12 +498,12 @@

     
     
    -7
    -8
    -9
    +21 +22 +23

    -
    # File 'lib/dropbox_api/connection_builder.rb', line 7
    +      
    # File 'lib/dropbox_api/connection_builder.rb', line 21
     
     def middleware
       @middleware ||= MiddleWare::Stack.new
    @@ -309,6 +511,39 @@ 

    + + +
    +

    + + #refresh_access_tokenObject + + + + + +

    + + + + + +
    +
    +
    +
    +29
    +30
    +31
    +32
    +
    +
    # File 'lib/dropbox_api/connection_builder.rb', line 29
    +
    +def refresh_access_token
    +  @access_token = @access_token.refresh!
    +  @on_token_refreshed.call(@access_token.to_hash) if @on_token_refreshed
    +end
    +
    @@ -316,9 +551,9 @@

    diff --git a/docs/DropboxApi/Endpoints.html b/docs/DropboxApi/Endpoints.html index bb4be73d..890edc99 100644 --- a/docs/DropboxApi/Endpoints.html +++ b/docs/DropboxApi/Endpoints.html @@ -6,15 +6,15 @@ Module: DropboxApi::Endpoints - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -109,9 +109,9 @@

    Defined Under Namespace

    diff --git a/docs/DropboxApi/Endpoints/Auth.html b/docs/DropboxApi/Endpoints/Auth.html index cd978e55..9dceb21e 100644 --- a/docs/DropboxApi/Endpoints/Auth.html +++ b/docs/DropboxApi/Endpoints/Auth.html @@ -6,15 +6,15 @@ Module: DropboxApi::Endpoints::Auth - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -105,9 +105,9 @@

    Defined Under Namespace

    diff --git a/docs/DropboxApi/Endpoints/Auth/TokenRevoke.html b/docs/DropboxApi/Endpoints/Auth/TokenRevoke.html index 5b2caea2..c6c515f8 100644 --- a/docs/DropboxApi/Endpoints/Auth/TokenRevoke.html +++ b/docs/DropboxApi/Endpoints/Auth/TokenRevoke.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Auth::TokenRevoke - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/auth/token/revoke".freeze
    +
    '/2/auth/token/revoke'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -235,12 +235,12 @@

     
     
    -10
     11
    -12
    +12 +13

    -
    # File 'lib/dropbox_api/endpoints/auth/token_revoke.rb', line 10
    +      
    # File 'lib/dropbox_api/endpoints/auth/token_revoke.rb', line 11
     
     add_endpoint :token_revoke do
       perform_request(nil)
    @@ -255,9 +255,9 @@ 

    diff --git a/docs/DropboxApi/Endpoints/Base.html b/docs/DropboxApi/Endpoints/Base.html index 90f6ee89..a994a559 100644 --- a/docs/DropboxApi/Endpoints/Base.html +++ b/docs/DropboxApi/Endpoints/Base.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Base - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -142,7 +142,88 @@

    +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(builder) ⇒ Base + + + + + +

    +
    +

    Returns a new instance of Base.

    + + +
    +
    +
    + + +
    + + + + + +
    +
    +
    +
    +4
    +5
    +6
    +7
    +
    +
    # File 'lib/dropbox_api/endpoints/base.rb', line 4
    +
    +def initialize(builder)
    +  @builder = builder
    +  build_connection
    +end
    +
    +
    + +
    @@ -165,13 +246,13 @@

     
     
    -3
    -4
    -5
    -6
    +9 +10 +11 +12

    -
    # File 'lib/dropbox_api/endpoints/base.rb', line 3
    +      
    # File 'lib/dropbox_api/endpoints/base.rb', line 9
     
     def self.add_endpoint(name, &block)
       define_method(name, block)
    @@ -187,9 +268,9 @@ 

    diff --git a/docs/DropboxApi/Endpoints/ContentDownload.html b/docs/DropboxApi/Endpoints/ContentDownload.html index 65462f11..93fc3fe4 100644 --- a/docs/DropboxApi/Endpoints/ContentDownload.html +++ b/docs/DropboxApi/Endpoints/ContentDownload.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::ContentDownload - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -123,7 +123,7 @@

  • - #build_request(params) ⇒ Object + #build_connection ⇒ Object @@ -145,15 +145,13 @@

  • - #initialize(builder) ⇒ ContentDownload + #build_request(params) ⇒ Object - constructor - @@ -161,8 +159,7 @@

    -

    A new instance of ContentDownload.

    -
    +

  • @@ -202,47 +199,46 @@

    Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -
    -

    - - #initialize(builder) ⇒ ContentDownload +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    +

    - - -
  • -
    -

    Returns a new instance of ContentDownload

    +
    +

    Instance Method Details

    + +
    +

    + + #build_connectionObject + -

    -
    -
    -
    + +

     
     
    -3
     4
     5
     6
    -7
    +7 +8
    -
    # File 'lib/dropbox_api/endpoints/content_download.rb', line 3
    +      
    # File 'lib/dropbox_api/endpoints/content_download.rb', line 4
     
    -def initialize(builder)
    -  @connection = builder.build("https://content.dropboxapi.com") do |c|
    +def build_connection
    +  @connection = @builder.build('https://content.dropboxapi.com') do |c|
         c.response :decode_result
       end
     end
    @@ -250,16 +246,9 @@

    - - - - -
    -

    Instance Method Details

    - -
    -

    +
    +

    #build_request(params) ⇒ Object @@ -274,7 +263,6 @@

     
     
    -9
     10
     11
     12
    @@ -282,10 +270,11 @@ 

    14 15 16 -17

    +17 +18 -
    # File 'lib/dropbox_api/endpoints/content_download.rb', line 9
    +      
    # File 'lib/dropbox_api/endpoints/content_download.rb', line 10
     
     def build_request(params)
       body = nil
    @@ -339,7 +328,6 @@ 

     
     
    -19
     20
     21
     22
    @@ -348,17 +336,18 @@ 

    25 26 27 -28

    +28 +29

    -
    # File 'lib/dropbox_api/endpoints/content_download.rb', line 19
    +      
    # File 'lib/dropbox_api/endpoints/content_download.rb', line 20
     
     def perform_request(params)
       response = get_response(params)
       api_result = process_response response
     
    -  # TODO: Stream response, current implementation will fail with very large
    -  #       files.
    +  # We just yield the whole response to the block, it'd be nice in the
    +  # future to support an interface that streams the response in chunks.
       yield response.body if block_given?
     
       api_result
    @@ -373,9 +362,9 @@ 

    diff --git a/docs/DropboxApi/Endpoints/ContentUpload.html b/docs/DropboxApi/Endpoints/ContentUpload.html index cec486f0..4a90430c 100644 --- a/docs/DropboxApi/Endpoints/ContentUpload.html +++ b/docs/DropboxApi/Endpoints/ContentUpload.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::ContentUpload - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -123,7 +123,7 @@

  • - #build_request(params, body) ⇒ Object + #build_connection ⇒ Object @@ -145,15 +145,13 @@

  • - #initialize(builder) ⇒ ContentUpload + #build_request(params, body) ⇒ Object - constructor - @@ -161,8 +159,7 @@

    -

    A new instance of ContentUpload.

    -
    +

  • @@ -202,47 +199,46 @@

    Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -
    -

    - - #initialize(builder) ⇒ ContentUpload +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    +

    - - -
  • -
    -

    Returns a new instance of ContentUpload

    +
    +

    Instance Method Details

    + +
    +

    + + #build_connectionObject + -

    -
    -
    -
    + +
     
     
    -3
     4
     5
     6
    -7
    +7 +8
    -
    # File 'lib/dropbox_api/endpoints/content_upload.rb', line 3
    +      
    # File 'lib/dropbox_api/endpoints/content_upload.rb', line 4
     
    -def initialize(builder)
    -  @connection = builder.build("https://content.dropboxapi.com") do |c|
    +def build_connection
    +  @connection = @builder.build('https://content.dropboxapi.com') do |c|
         c.response :decode_result
       end
     end
    @@ -250,16 +246,9 @@

    - -
    - - -
    -

    Instance Method Details

    - -
    -

    +
    +

    #build_request(params, body) ⇒ Object @@ -274,7 +263,6 @@

     
     
    -9
     10
     11
     12
    @@ -284,10 +272,11 @@ 

    16 17 18 -19

    +19 +20 -
    # File 'lib/dropbox_api/endpoints/content_upload.rb', line 9
    +      
    # File 'lib/dropbox_api/endpoints/content_upload.rb', line 10
     
     def build_request(params, body)
       headers = {
    @@ -321,12 +310,12 @@ 

     
     
    -21
     22
    -23
    +23 +24

    -
    # File 'lib/dropbox_api/endpoints/content_upload.rb', line 21
    +      
    # File 'lib/dropbox_api/endpoints/content_upload.rb', line 22
     
     def perform_request(params, content)
       process_response(get_response(params, content))
    @@ -341,9 +330,9 @@ 

    diff --git a/docs/DropboxApi/Endpoints/Files.html b/docs/DropboxApi/Endpoints/Files.html index 6618a7c5..d801a096 100644 --- a/docs/DropboxApi/Endpoints/Files.html +++ b/docs/DropboxApi/Endpoints/Files.html @@ -6,15 +6,15 @@ Module: DropboxApi::Endpoints::Files - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -79,7 +79,7 @@
    Defined in:
    lib/dropbox_api/endpoints/files/copy.rb,
    - lib/dropbox_api/endpoints/files/move.rb,
    lib/dropbox_api/endpoints/files/delete.rb,
    lib/dropbox_api/endpoints/files/search.rb,
    lib/dropbox_api/endpoints/files/upload.rb,
    lib/dropbox_api/endpoints/files/restore.rb,
    lib/dropbox_api/endpoints/files/download.rb,
    lib/dropbox_api/endpoints/files/save_url.rb,
    lib/dropbox_api/endpoints/files/copy_batch.rb,
    lib/dropbox_api/endpoints/files/get_preview.rb,
    lib/dropbox_api/endpoints/files/list_folder.rb,
    lib/dropbox_api/endpoints/files/delete_batch.rb,
    lib/dropbox_api/endpoints/files/get_metadata.rb,
    lib/dropbox_api/endpoints/files/create_folder.rb,
    lib/dropbox_api/endpoints/files/get_thumbnail.rb,
    lib/dropbox_api/endpoints/files/list_revisions.rb,
    lib/dropbox_api/endpoints/files/copy_batch_check.rb,
    lib/dropbox_api/endpoints/files/copy_reference_get.rb,
    lib/dropbox_api/endpoints/files/delete_batch_check.rb,
    lib/dropbox_api/endpoints/files/get_temporary_link.rb,
    lib/dropbox_api/endpoints/files/permanently_delete.rb,
    lib/dropbox_api/endpoints/files/copy_reference_save.rb,
    lib/dropbox_api/endpoints/files/create_folder_batch.rb,
    lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb,
    lib/dropbox_api/endpoints/files/list_folder_continue.rb,
    lib/dropbox_api/endpoints/files/list_folder_longpoll.rb,
    lib/dropbox_api/endpoints/files/upload_session_start.rb,
    lib/dropbox_api/endpoints/files/upload_session_finish.rb,
    lib/dropbox_api/endpoints/files/upload_session_append_v2.rb,
    lib/dropbox_api/endpoints/files/create_folder_batch_check.rb,
    lib/dropbox_api/endpoints/files/save_url_check_job_status.rb,
    lib/dropbox_api/endpoints/file_requests/create_file_request.rb,
    lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb
    + lib/dropbox_api/endpoints/files/move.rb,
    lib/dropbox_api/endpoints/files/delete.rb,
    lib/dropbox_api/endpoints/files/search.rb,
    lib/dropbox_api/endpoints/files/upload.rb,
    lib/dropbox_api/endpoints/files/restore.rb,
    lib/dropbox_api/endpoints/files/download.rb,
    lib/dropbox_api/endpoints/files/save_url.rb,
    lib/dropbox_api/endpoints/files/copy_batch.rb,
    lib/dropbox_api/endpoints/files/get_preview.rb,
    lib/dropbox_api/endpoints/files/list_folder.rb,
    lib/dropbox_api/endpoints/files/delete_batch.rb,
    lib/dropbox_api/endpoints/files/get_metadata.rb,
    lib/dropbox_api/endpoints/files/create_folder.rb,
    lib/dropbox_api/endpoints/files/get_thumbnail.rb,
    lib/dropbox_api/endpoints/files/list_revisions.rb,
    lib/dropbox_api/endpoints/files/search_continue.rb,
    lib/dropbox_api/endpoints/files/copy_batch_check.rb,
    lib/dropbox_api/endpoints/files/copy_reference_get.rb,
    lib/dropbox_api/endpoints/files/delete_batch_check.rb,
    lib/dropbox_api/endpoints/files/get_temporary_link.rb,
    lib/dropbox_api/endpoints/files/permanently_delete.rb,
    lib/dropbox_api/endpoints/files/copy_reference_save.rb,
    lib/dropbox_api/endpoints/files/create_folder_batch.rb,
    lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb,
    lib/dropbox_api/endpoints/files/list_folder_continue.rb,
    lib/dropbox_api/endpoints/files/list_folder_longpoll.rb,
    lib/dropbox_api/endpoints/files/upload_session_start.rb,
    lib/dropbox_api/endpoints/files/upload_session_finish.rb,
    lib/dropbox_api/endpoints/files/upload_session_append_v2.rb,
    lib/dropbox_api/endpoints/files/create_folder_batch_check.rb,
    lib/dropbox_api/endpoints/files/save_url_check_job_status.rb,
    lib/dropbox_api/endpoints/file_requests/create_file_request.rb,
    lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb
    @@ -91,7 +91,7 @@

    Defined Under Namespace

    - Classes: Copy, CopyBatch, CopyBatchCheck, CopyReferenceGet, CopyReferenceSave, CreateFileRequest, CreateFolder, CreateFolderBatch, CreateFolderBatchCheck, Delete, DeleteBatch, DeleteBatchCheck, Download, GetMetadata, GetPreview, GetTemporaryLink, GetThumbnail, GetThumbnailBatch, ListFolder, ListFolderContinue, ListFolderGetLatestCursor, ListFolderLongpoll, ListRevisions, Move, PermanentlyDelete, Restore, SaveUrl, SaveUrlCheckJobStatus, Search, Upload, UploadSessionAppendV2, UploadSessionFinish, UploadSessionStart + Classes: Copy, CopyBatch, CopyBatchCheck, CopyReferenceGet, CopyReferenceSave, CreateFileRequest, CreateFolder, CreateFolderBatch, CreateFolderBatchCheck, Delete, DeleteBatch, DeleteBatchCheck, Download, GetMetadata, GetPreview, GetTemporaryLink, GetThumbnail, GetThumbnailBatch, ListFolder, ListFolderContinue, ListFolderGetLatestCursor, ListFolderLongpoll, ListRevisions, Move, PermanentlyDelete, Restore, SaveUrl, SaveUrlCheckJobStatus, Search, SearchContinue, Upload, UploadSessionAppendV2, UploadSessionFinish, UploadSessionStart

    @@ -107,9 +107,9 @@

    Defined Under Namespace

    diff --git a/docs/DropboxApi/Endpoints/Files/Copy.html b/docs/DropboxApi/Endpoints/Files/Copy.html index a3c066ca..18b0fca0 100644 --- a/docs/DropboxApi/Endpoints/Files/Copy.html +++ b/docs/DropboxApi/Endpoints/Files/Copy.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::Copy - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/copy".freeze
    +
    '/2/files/copy'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -287,20 +287,20 @@

     
     
    -14
     15
     16
     17
     18
    -19
    +19 +20 -
    # File 'lib/dropbox_api/endpoints/files/copy.rb', line 14
    +      
    # File 'lib/dropbox_api/endpoints/files/copy.rb', line 15
     
     add_endpoint :copy do |from, to|
       perform_request({
    -    :from_path => from,
    -    :to_path => to
    +    from_path: from,
    +    to_path: to
       })
     end
    @@ -313,9 +313,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/CopyBatch.html b/docs/DropboxApi/Endpoints/Files/CopyBatch.html index 3a8351a3..0fe81527 100644 --- a/docs/DropboxApi/Endpoints/Files/CopyBatch.html +++ b/docs/DropboxApi/Endpoints/Files/CopyBatch.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::CopyBatch - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/copy_batch_v2".freeze
    +
    '/2/files/copy_batch_v2'
    ResultType = @@ -196,7 +196,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -207,11 +207,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -315,7 +315,6 @@

     
     
    -24
     25
     26
     27
    @@ -324,10 +323,11 @@ 

    30 31 32 -33

    +33 +34

    -
    # File 'lib/dropbox_api/endpoints/files/copy_batch.rb', line 24
    +      
    # File 'lib/dropbox_api/endpoints/files/copy_batch.rb', line 25
     
     add_endpoint :copy_batch do |entries, options = {}|
       validate_options([
    @@ -336,7 +336,7 @@ 

    options[:autorename] ||= false perform_request(options.merge({ - :entries => entries + entries: entries })) end

    @@ -349,9 +349,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/CopyBatchCheck.html b/docs/DropboxApi/Endpoints/Files/CopyBatchCheck.html index b8a9bbe9..e9abfd0b 100644 --- a/docs/DropboxApi/Endpoints/Files/CopyBatchCheck.html +++ b/docs/DropboxApi/Endpoints/Files/CopyBatchCheck.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::CopyBatchCheck - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    '/2/files/copy_batch/check_v2'.freeze
    +
    '/2/files/copy_batch/check_v2'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -275,15 +275,15 @@

     
     
    -16
     17
    -18
    +18 +19

    -
    # File 'lib/dropbox_api/endpoints/files/copy_batch_check.rb', line 16
    +      
    # File 'lib/dropbox_api/endpoints/files/copy_batch_check.rb', line 17
     
     add_endpoint :copy_batch_check do |async_job_id|
    -  perform_request :async_job_id => async_job_id
    +  perform_request async_job_id: async_job_id
     end
    @@ -295,9 +295,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/CopyReferenceGet.html b/docs/DropboxApi/Endpoints/Files/CopyReferenceGet.html index 3fa19bda..1f8b0026 100644 --- a/docs/DropboxApi/Endpoints/Files/CopyReferenceGet.html +++ b/docs/DropboxApi/Endpoints/Files/CopyReferenceGet.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::CopyReferenceGet - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/copy_reference/get".freeze
    +
    '/2/files/copy_reference/get'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -270,18 +270,18 @@

     
     
    -15
     16
     17
     18
    -19
    +19 +20

    -
    # File 'lib/dropbox_api/endpoints/files/copy_reference_get.rb', line 15
    +      
    # File 'lib/dropbox_api/endpoints/files/copy_reference_get.rb', line 16
     
     add_endpoint :copy_reference_get do |path|
       perform_request({
    -    :path => path
    +    path: path
       })
     end
    @@ -294,9 +294,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/CopyReferenceSave.html b/docs/DropboxApi/Endpoints/Files/CopyReferenceSave.html index 8085f72d..cc911eb6 100644 --- a/docs/DropboxApi/Endpoints/Files/CopyReferenceSave.html +++ b/docs/DropboxApi/Endpoints/Files/CopyReferenceSave.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::CopyReferenceSave - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/copy_reference/save".freeze
    +
    '/2/files/copy_reference/save'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -284,20 +284,20 @@

     
     
    -15
     16
     17
     18
     19
    -20
    +20 +21

    -
    # File 'lib/dropbox_api/endpoints/files/copy_reference_save.rb', line 15
    +      
    # File 'lib/dropbox_api/endpoints/files/copy_reference_save.rb', line 16
     
     add_endpoint :copy_reference_save do |copy_reference, path|
       perform_request({
    -    :copy_reference => copy_reference,
    -    :path => path
    +    copy_reference: copy_reference,
    +    path: path
       })
     end
    @@ -310,9 +310,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/CreateFileRequest.html b/docs/DropboxApi/Endpoints/Files/CreateFileRequest.html index a28d4b08..5aad2f57 100644 --- a/docs/DropboxApi/Endpoints/Files/CreateFileRequest.html +++ b/docs/DropboxApi/Endpoints/Files/CreateFileRequest.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::CreateFileRequest - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/file_requests/create".freeze
    +
    '/2/file_requests/create'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -271,20 +271,20 @@

     
     
    -14
     15
     16
     17
     18
    -19
    +19 +20

    -
    # File 'lib/dropbox_api/endpoints/file_requests/create_file_request.rb', line 14
    +      
    # File 'lib/dropbox_api/endpoints/file_requests/create_file_request.rb', line 15
     
     add_endpoint :create_file_request do |title, destination|
       perform_request({
    -    :title => title,
    -    :destination => destination
    +    title: title,
    +    destination: destination
       })
     end
    @@ -297,9 +297,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/CreateFolder.html b/docs/DropboxApi/Endpoints/Files/CreateFolder.html index b0f46968..ee33745a 100644 --- a/docs/DropboxApi/Endpoints/Files/CreateFolder.html +++ b/docs/DropboxApi/Endpoints/Files/CreateFolder.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::CreateFolder - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/create_folder".freeze
    +
    '/2/files/create_folder'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -271,18 +271,18 @@

     
     
    -12
     13
     14
     15
    -16
    +16 +17

    -
    # File 'lib/dropbox_api/endpoints/files/create_folder.rb', line 12
    +      
    # File 'lib/dropbox_api/endpoints/files/create_folder.rb', line 13
     
     add_endpoint :create_folder do |path|
       perform_request({
    -    :path => path
    +    path: path
       })
     end
    @@ -295,9 +295,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/CreateFolderBatch.html b/docs/DropboxApi/Endpoints/Files/CreateFolderBatch.html index 0f52088e..d1d7655f 100644 --- a/docs/DropboxApi/Endpoints/Files/CreateFolderBatch.html +++ b/docs/DropboxApi/Endpoints/Files/CreateFolderBatch.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::CreateFolderBatch - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/create_folder_batch".freeze
    +
    '/2/files/create_folder_batch'
    ResultType = @@ -196,7 +196,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -207,11 +207,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -329,7 +329,6 @@

     
     
    -27
     28
     29
     30
    @@ -340,10 +339,11 @@ 

    35 36 37 -38

    +38 +39

    -
    # File 'lib/dropbox_api/endpoints/files/create_folder_batch.rb', line 27
    +      
    # File 'lib/dropbox_api/endpoints/files/create_folder_batch.rb', line 28
     
     add_endpoint :create_folder_batch do |paths, options = {}|
       validate_options([
    @@ -354,7 +354,7 @@ 

    options[:force_async] ||= false perform_request(options.merge({ - :paths => paths + paths: paths })) end

    @@ -367,9 +367,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html b/docs/DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html index b708f97b..2a4aec8b 100644 --- a/docs/DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html +++ b/docs/DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::CreateFolderBatchCheck - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/create_folder_batch/check".freeze
    +
    '/2/files/create_folder_batch/check'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -274,18 +274,18 @@

     
     
    -15
     16
     17
     18
    -19
    +19 +20

    -
    # File 'lib/dropbox_api/endpoints/files/create_folder_batch_check.rb', line 15
    +      
    # File 'lib/dropbox_api/endpoints/files/create_folder_batch_check.rb', line 16
     
     add_endpoint :create_folder_batch_check do |async_job_id|
       perform_request({
    -    :async_job_id => async_job_id
    +    async_job_id: async_job_id
       })
     end
    @@ -298,9 +298,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/Delete.html b/docs/DropboxApi/Endpoints/Files/Delete.html index 183f23c6..76f4607b 100644 --- a/docs/DropboxApi/Endpoints/Files/Delete.html +++ b/docs/DropboxApi/Endpoints/Files/Delete.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::Delete - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/delete".freeze
    +
    '/2/files/delete'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -303,22 +303,22 @@

     
     
    -24
     25
     26
     27
     28
     29
    -30
    +30 +31

    -
    # File 'lib/dropbox_api/endpoints/files/delete.rb', line 24
    +      
    # File 'lib/dropbox_api/endpoints/files/delete.rb', line 25
     
     add_endpoint :delete do |path, options = {}|
       validate_options([:parent_rev], options)
     
       perform_request options.merge({
    -    :path => path
    +    path: path
       })
     end
    @@ -331,9 +331,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/DeleteBatch.html b/docs/DropboxApi/Endpoints/Files/DeleteBatch.html index 3c205cf2..7bb4b2cd 100644 --- a/docs/DropboxApi/Endpoints/Files/DeleteBatch.html +++ b/docs/DropboxApi/Endpoints/Files/DeleteBatch.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::DeleteBatch - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/delete_batch".freeze
    +
    '/2/files/delete_batch'
    ResultType = @@ -180,7 +180,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -191,11 +191,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -271,18 +271,18 @@

     
     
    -16
     17
     18
     19
    -20
    +20 +21

    -
    # File 'lib/dropbox_api/endpoints/files/delete_batch.rb', line 16
    +      
    # File 'lib/dropbox_api/endpoints/files/delete_batch.rb', line 17
     
     add_endpoint :delete_batch do |entries|
       perform_request({
    -    :entries => entries
    +    entries: entries
       })
     end
    @@ -295,9 +295,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/DeleteBatchCheck.html b/docs/DropboxApi/Endpoints/Files/DeleteBatchCheck.html index 42e2f74c..35f2e50a 100644 --- a/docs/DropboxApi/Endpoints/Files/DeleteBatchCheck.html +++ b/docs/DropboxApi/Endpoints/Files/DeleteBatchCheck.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::DeleteBatchCheck - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/delete_batch/check".freeze
    +
    '/2/files/delete_batch/check'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -273,18 +273,18 @@

     
     
    -14
     15
     16
     17
    -18
    +18 +19

    -
    # File 'lib/dropbox_api/endpoints/files/delete_batch_check.rb', line 14
    +      
    # File 'lib/dropbox_api/endpoints/files/delete_batch_check.rb', line 15
     
     add_endpoint :delete_batch_check do |async_job_id|
       perform_request({
    -    :async_job_id => async_job_id
    +    async_job_id: async_job_id
       })
     end
    @@ -297,9 +297,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/Download.html b/docs/DropboxApi/Endpoints/Files/Download.html index b85b5839..993bd491 100644 --- a/docs/DropboxApi/Endpoints/Files/Download.html +++ b/docs/DropboxApi/Endpoints/Files/Download.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::Download - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/download".freeze
    +
    '/2/files/download'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from ContentDownload

    -

    #build_request, #initialize, #perform_request

    +

    #build_connection, #build_request, #perform_request

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::ContentDownload

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -254,15 +254,15 @@

     
     
    -11
     12
    -13
    +13 +14

    -
    # File 'lib/dropbox_api/endpoints/files/download.rb', line 11
    +      
    # File 'lib/dropbox_api/endpoints/files/download.rb', line 12
     
     add_endpoint :download do |path, &block|
    -  perform_request({:path => path}, &block)
    +  perform_request({path: path}, &block)
     end
    @@ -274,9 +274,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/GetMetadata.html b/docs/DropboxApi/Endpoints/Files/GetMetadata.html index fe03c207..be36e194 100644 --- a/docs/DropboxApi/Endpoints/Files/GetMetadata.html +++ b/docs/DropboxApi/Endpoints/Files/GetMetadata.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::GetMetadata - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/get_metadata".freeze
    +
    '/2/files/get_metadata'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -330,7 +330,6 @@

     
     
    -29
     30
     31
     32
    @@ -340,10 +339,11 @@ 

    36 37 38 -39

    +39 +40

    -
    # File 'lib/dropbox_api/endpoints/files/get_metadata.rb', line 29
    +      
    # File 'lib/dropbox_api/endpoints/files/get_metadata.rb', line 30
     
     add_endpoint :get_metadata do |path, options = {}|
       validate_options([
    @@ -353,7 +353,7 @@ 

    ], options) perform_request(options.merge({ - :path => path + path: path })) end

    @@ -366,9 +366,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/GetPreview.html b/docs/DropboxApi/Endpoints/Files/GetPreview.html index 25d7f242..f743838d 100644 --- a/docs/DropboxApi/Endpoints/Files/GetPreview.html +++ b/docs/DropboxApi/Endpoints/Files/GetPreview.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::GetPreview - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/get_preview".freeze
    +
    '/2/files/get_preview'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from ContentDownload

    -

    #build_request, #initialize, #perform_request

    +

    #build_connection, #build_request, #perform_request

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::ContentDownload

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -256,15 +256,15 @@

     
     
    -13
     14
    -15
    +15 +16

    -
    # File 'lib/dropbox_api/endpoints/files/get_preview.rb', line 13
    +      
    # File 'lib/dropbox_api/endpoints/files/get_preview.rb', line 14
     
     add_endpoint :get_preview do |path, &block|
    -  perform_request({:path => path}, &block)
    +  perform_request({path: path}, &block)
     end
    @@ -276,9 +276,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/GetTemporaryLink.html b/docs/DropboxApi/Endpoints/Files/GetTemporaryLink.html index 6ba6c10e..0f8e235e 100644 --- a/docs/DropboxApi/Endpoints/Files/GetTemporaryLink.html +++ b/docs/DropboxApi/Endpoints/Files/GetTemporaryLink.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::GetTemporaryLink - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/get_temporary_link".freeze
    +
    '/2/files/get_temporary_link'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -256,15 +256,15 @@

    -
    # File 'lib/dropbox_api/endpoints/files/get_temporary_link.rb', line 13
    +      
    # File 'lib/dropbox_api/endpoints/files/get_temporary_link.rb', line 14
     
     add_endpoint :get_temporary_link do |path|
    -  perform_request({:path => path})
    +  perform_request({path: path})
     end
    @@ -276,9 +276,9 @@

    Path =
    -
    "/2/files/get_thumbnail".freeze
    +
    '/2/files/get_thumbnail'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from ContentDownload

    -

    #build_request, #initialize, #perform_request

    +

    #build_connection, #build_request, #perform_request

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::ContentDownload

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -346,7 +346,6 @@

     
     
    -47
     48
     49
     50
    @@ -354,10 +353,11 @@ 

    52 53 54 -55

    +55 +56

    -
    # File 'lib/dropbox_api/endpoints/files/get_thumbnail.rb', line 47
    +      
    # File 'lib/dropbox_api/endpoints/files/get_thumbnail.rb', line 48
     
     add_endpoint :get_thumbnail do |path, options = {}, &block|
       validate_options([:format, :size], options)
    @@ -365,7 +365,7 @@ 

    options[:size] ||= :w64h64 perform_request(options.merge({ - :path => path + path: path }), &block) end

    @@ -378,9 +378,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch.html b/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch.html index 30851afc..7718988c 100644 --- a/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch.html +++ b/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::GetThumbnailBatch - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -127,7 +127,7 @@

    Path =
    -
    "/2/files/get_thumbnail_batch".freeze
    +
    '/2/files/get_thumbnail_batch'
    ResultType = @@ -225,7 +225,7 @@

    Methods included from Methods inherited from RpcContent

    -

    #initialize

    +

    #build_connection

    @@ -236,7 +236,7 @@

    Methods inherited from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -247,11 +247,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::RpcContent

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -276,18 +276,18 @@

     
     
    -31
     32
     33
     34
    -35
    +35 +36

    -
    # File 'lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb', line 31
    +      
    # File 'lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb', line 32
     
     def build_entries_params(paths, options)
       paths.map do |path|
    -    options.merge({ :path => path })
    +    options.merge({ path: path })
       end
     end
    @@ -391,17 +391,17 @@

     
     
    -22
     23
     24
     25
     26
     27
     28
    -29
    +29 +30

    -
    # File 'lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb', line 22
    +      
    # File 'lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb', line 23
     
     add_endpoint :get_thumbnail_batch do |paths, options = {}|
       validate_options([:format, :size, :mode], options)
    @@ -409,7 +409,7 @@ 

    options[:size] ||= :w64h64 options[:mode] ||= :strict - perform_request :entries => build_entries_params(paths, options) + perform_request entries: build_entries_params(paths, options) end

    @@ -421,9 +421,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/ListFolder.html b/docs/DropboxApi/Endpoints/Files/ListFolder.html index a65c0164..654aaf89 100644 --- a/docs/DropboxApi/Endpoints/Files/ListFolder.html +++ b/docs/DropboxApi/Endpoints/Files/ListFolder.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::ListFolder - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/list_folder".freeze
    +
    '/2/files/list_folder'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -340,7 +340,6 @@

     
     
    -28
     29
     30
     31
    @@ -358,10 +357,11 @@ 

    43 44 45 -46

    +46 +47

    -
    # File 'lib/dropbox_api/endpoints/files/list_folder.rb', line 28
    +      
    # File 'lib/dropbox_api/endpoints/files/list_folder.rb', line 29
     
     add_endpoint :list_folder do |path, options = {}|
       validate_options([
    @@ -379,7 +379,7 @@ 

    options[:limit] = options[:limit] if options[:limit] perform_request options.merge({ - :path => path + path: path }) end

    @@ -392,9 +392,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/ListFolderContinue.html b/docs/DropboxApi/Endpoints/Files/ListFolderContinue.html index f3cd4e51..c47ec1ab 100644 --- a/docs/DropboxApi/Endpoints/Files/ListFolderContinue.html +++ b/docs/DropboxApi/Endpoints/Files/ListFolderContinue.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::ListFolderContinue - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -132,7 +132,7 @@

    Path =
    -
    "/2/files/list_folder/continue".freeze
    +
    '/2/files/list_folder/continue'
    ResultType = @@ -197,7 +197,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -208,11 +208,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -268,15 +268,15 @@

     
     
    -16
     17
    -18
    +18 +19

    -
    # File 'lib/dropbox_api/endpoints/files/list_folder_continue.rb', line 16
    +      
    # File 'lib/dropbox_api/endpoints/files/list_folder_continue.rb', line 17
     
     add_endpoint :list_folder_continue do |cursor|
    -  perform_request :cursor => cursor
    +  perform_request cursor: cursor
     end
    @@ -288,9 +288,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html b/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html index 4703b093..2ca05248 100644 --- a/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html +++ b/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::ListFolderGetLatestCursor - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/list_folder/get_latest_cursor".freeze
    +
    '/2/files/list_folder/get_latest_cursor'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -319,7 +319,6 @@

     
     
    -27
     28
     29
     30
    @@ -332,10 +331,11 @@ 

    37 38 39 -40

    +40 +41

    -
    # File 'lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb', line 27
    +      
    # File 'lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb', line 28
     
     add_endpoint :list_folder_get_latest_cursor do |options = {}|
       validate_options([
    @@ -361,9 +361,9 @@ 

    diff --git a/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll.html b/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll.html index a9397cc9..34c276b2 100644 --- a/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll.html +++ b/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::ListFolderLongpoll - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -127,7 +127,7 @@

    Path =
    -
    "/2/files/list_folder/longpoll".freeze
    +
    '/2/files/list_folder/longpoll'
    ResultType = @@ -203,7 +203,7 @@

    Methods included from Methods inherited from RpcNotify

    -

    #initialize

    +

    #build_connection

    @@ -214,7 +214,7 @@

    Methods inherited from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -225,11 +225,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::RpcNotify

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -316,7 +316,6 @@

     
     
    -24
     25
     26
     27
    @@ -325,10 +324,11 @@ 

    30 31 32 -33

    +33 +34

    -
    # File 'lib/dropbox_api/endpoints/files/list_folder_longpoll.rb', line 24
    +      
    # File 'lib/dropbox_api/endpoints/files/list_folder_longpoll.rb', line 25
     
     add_endpoint :list_folder_longpoll do |cursor, options = {}|
       validate_options([
    @@ -337,7 +337,7 @@ 

    options[:timeout] ||= 30 perform_request options.merge({ - :cursor => cursor + cursor: cursor }) end

    @@ -350,9 +350,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/ListRevisions.html b/docs/DropboxApi/Endpoints/Files/ListRevisions.html index d30d5c0d..73a61366 100644 --- a/docs/DropboxApi/Endpoints/Files/ListRevisions.html +++ b/docs/DropboxApi/Endpoints/Files/ListRevisions.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::ListRevisions - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/list_revisions".freeze
    +
    '/2/files/list_revisions'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -294,7 +294,6 @@

     
     
    -15
     16
     17
     18
    @@ -303,10 +302,11 @@ 

    21 22 23 -24

    +24 +25

    -
    # File 'lib/dropbox_api/endpoints/files/list_revisions.rb', line 15
    +      
    # File 'lib/dropbox_api/endpoints/files/list_revisions.rb', line 16
     
     add_endpoint :list_revisions do |path, options = {}|
       validate_options([
    @@ -315,7 +315,7 @@ 

    options[:limit] ||= 10 perform_request options.merge({ - :path => path + path: path }) end

    @@ -328,9 +328,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/Move.html b/docs/DropboxApi/Endpoints/Files/Move.html index e3044441..49fc065f 100644 --- a/docs/DropboxApi/Endpoints/Files/Move.html +++ b/docs/DropboxApi/Endpoints/Files/Move.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::Move - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/move".freeze
    +
    '/2/files/move'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -314,7 +314,6 @@

     
     
    -19
     20
     21
     22
    @@ -326,10 +325,11 @@ 

    28 29 30 -31

    +31 +32

    -
    # File 'lib/dropbox_api/endpoints/files/move.rb', line 19
    +      
    # File 'lib/dropbox_api/endpoints/files/move.rb', line 20
     
     add_endpoint :move do |from, to, options = {}|
       # We're not implementing support for the `allow_shared_folder` option
    @@ -340,8 +340,8 @@ 

    ], options) perform_request options.merge({ - :from_path => from, - :to_path => to + from_path: from, + to_path: to }) end

    @@ -354,9 +354,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/PermanentlyDelete.html b/docs/DropboxApi/Endpoints/Files/PermanentlyDelete.html index 1352edd7..64792946 100644 --- a/docs/DropboxApi/Endpoints/Files/PermanentlyDelete.html +++ b/docs/DropboxApi/Endpoints/Files/PermanentlyDelete.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::PermanentlyDelete - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/permanently_delete".freeze
    +
    '/2/files/permanently_delete'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -299,22 +299,22 @@

     
     
    -20
     21
     22
     23
     24
     25
    -26
    +26 +27

    -
    # File 'lib/dropbox_api/endpoints/files/permanently_delete.rb', line 20
    +      
    # File 'lib/dropbox_api/endpoints/files/permanently_delete.rb', line 21
     
     add_endpoint :permanently_delete do |path, options = {}|
       validate_options([:parent_rev], options)
     
       perform_request options.merge({
    -    :path => path
    +    path: path
       })
     end
    @@ -327,9 +327,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/Restore.html b/docs/DropboxApi/Endpoints/Files/Restore.html index 0a87665e..0604ccf1 100644 --- a/docs/DropboxApi/Endpoints/Files/Restore.html +++ b/docs/DropboxApi/Endpoints/Files/Restore.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::Restore - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/restore".freeze
    +
    '/2/files/restore'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -269,20 +269,20 @@

     
     
    -12
     13
     14
     15
     16
    -17
    +17 +18

    -
    # File 'lib/dropbox_api/endpoints/files/restore.rb', line 12
    +      
    # File 'lib/dropbox_api/endpoints/files/restore.rb', line 13
     
     add_endpoint :restore do |path, rev|
       perform_request({
    -    :path => path,
    -    :rev => rev
    +    path: path,
    +    rev: rev
       })
     end
    @@ -295,9 +295,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/SaveUrl.html b/docs/DropboxApi/Endpoints/Files/SaveUrl.html index 32016ff6..18af3d00 100644 --- a/docs/DropboxApi/Endpoints/Files/SaveUrl.html +++ b/docs/DropboxApi/Endpoints/Files/SaveUrl.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::SaveUrl - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/save_url".freeze
    +
    '/2/files/save_url'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -288,20 +288,20 @@

     
     
    -15
     16
     17
     18
     19
    -20
    +20 +21

    -
    # File 'lib/dropbox_api/endpoints/files/save_url.rb', line 15
    +      
    # File 'lib/dropbox_api/endpoints/files/save_url.rb', line 16
     
     add_endpoint :save_url do |path, url|
       perform_request({
    -    :path => path,
    -    :url => url
    +    path: path,
    +    url: url
       })
     end
    @@ -314,9 +314,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html b/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html index 4e1fd811..8bbc4120 100644 --- a/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html +++ b/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -120,7 +120,7 @@

    Path =
    -
    "/2/files/save_url/check_job_status".freeze
    +
    '/2/files/save_url/check_job_status'
    ResultType = @@ -185,7 +185,7 @@

    Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -196,11 +196,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -272,18 +272,18 @@

     
     
    -13
     14
     15
     16
    -17
    +17 +18

    -
    # File 'lib/dropbox_api/endpoints/files/save_url_check_job_status.rb', line 13
    +      
    # File 'lib/dropbox_api/endpoints/files/save_url_check_job_status.rb', line 14
     
     add_endpoint :save_url_check_job_status do |job_id|
       perform_request({
    -    :async_job_id => job_id
    +    async_job_id: job_id
       })
     end
    @@ -296,9 +296,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/Search.html b/docs/DropboxApi/Endpoints/Files/Search.html index f7753f22..1e64606c 100644 --- a/docs/DropboxApi/Endpoints/Files/Search.html +++ b/docs/DropboxApi/Endpoints/Files/Search.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::Search - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,12 +125,12 @@

    Path =
    -
    "/2/files/search".freeze
    +
    '/2/files/search_v2'
    ResultType =
    -
    DropboxApi::Results::SearchResult
    +
    DropboxApi::Results::SearchV2Result
    ErrorType = @@ -157,7 +157,7 @@

  • - #search(query, path = "", options = {}) ⇒ Object + #search(query, options = nil, match_field_options = nil) ⇒ Object @@ -201,7 +201,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -228,7 +228,7 @@

    Instance Method Details

    - #search(query, path = "", options = {}) ⇒ Object + #search(query, options = nil, match_field_options = nil) ⇒ Object @@ -258,84 +258,48 @@

    — -

    The string to search for. The search string is -split on spaces into multiple tokens. For file name searching, the last -token is used for prefix matching (i.e. "bat c" matches "bat cave" but -not "batman car").

    +

    The string to search for. May match across +multiple fields based on the request arguments.

  • - path + options - (String) + (DropboxApi::Metadata::SearchOptions) - (defaults to: "") + (defaults to: nil) — -

    The path in the user's Dropbox to search.

    +

    Options for more +targeted search results. This field is optional.

  • - - - - - - - - - -

    Options Hash (options):

    -
      - -
    • - start - (Numeric) - - - - - —

      The starting index within the search -results (used for paging). The default for this field is 0.

      -
      - -
    • - -
    • - max_results - (Numeric) - - - - - —

      The maximum number of search -results to return. The default for this field is 100.

      -
      - -
    • - -
    • - mode - (:filename, :filename_and_content, :deleted_filename) - - - - - —

      The search mode. Note that searching file content is only -available for Dropbox Business accounts. The default is filename.

      +
    • + + match_field_options + + + (DropboxApi::Metadata::SearchMatchFieldOptions) + + + (defaults to: nil) + + + — +

      Options for search results match fields. This field is optional.

      - -
    • -
    + + @@ -345,39 +309,27 @@

     
     
    +22
    +23
    +24
    +25
    +26
     27
     28
     29
    -30
    -31
    -32
    -33
    -34
    -35
    -36
    -37
    -38
    -39
    -40
    -41
    +30

    -
    # File 'lib/dropbox_api/endpoints/files/search.rb', line 27
    -
    -add_endpoint :search do |query, path = "", options = {}|
    -  validate_options([
    -    :start,
    -    :max_results,
    -    :mode
    -  ], options)
    -  options[:start] ||= 0
    -  options[:max_results] ||= 100
    -  options[:mode] ||= :filename
    -
    -  perform_request options.merge({
    -    :query => query,
    -    :path => path
    -  })
    +      
    # File 'lib/dropbox_api/endpoints/files/search.rb', line 22
    +
    +add_endpoint :search do |query, options = nil, match_field_options = nil|
    +  params = { query: query }
    +
    +  params[:options] = options.to_hash unless options.nil?
    +
    +  params[:match_field_options] = match_field_options.to_hash unless match_field_options.nil?
    +
    +  perform_request(params)
     end
    @@ -389,9 +341,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/SearchContinue.html b/docs/DropboxApi/Endpoints/Files/SearchContinue.html new file mode 100644 index 00000000..47fcbd2e --- /dev/null +++ b/docs/DropboxApi/Endpoints/Files/SearchContinue.html @@ -0,0 +1,300 @@ + + + + + + + Class: DropboxApi::Endpoints::Files::SearchContinue + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Endpoints::Files::SearchContinue + + + +

    +
    + +
    +
    Inherits:
    +
    + Rpc + +
      +
    • Object
    • + + + + + + + +
    + show all + +
    +
    + + + + + + +
    +
    Includes:
    +
    OptionsValidator
    +
    + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/endpoints/files/search_continue.rb
    +
    + +
    + + + +

    + Constant Summary + collapse +

    + +
    + +
    Method = + +
    +
    :post
    + +
    Path = + +
    +
    '/2/files/search/continue_v2'
    + +
    ResultType = + +
    +
    DropboxApi::Results::SearchV2Result
    + +
    ErrorType = + +
    +
    DropboxApi::Errors::SearchError
    + +
    + + + + + + + + + +

    + Instance Method Summary + collapse +

    + + + + + + + + + + + + + +

    Methods included from OptionsValidator

    +

    #validate_options

    + + + + + + + + + +

    Methods inherited from Rpc

    +

    #build_connection, #build_request, #request_body

    + + + + + + + + + +

    Methods inherited from Base

    +

    add_endpoint, #initialize

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #search_continue(cursor) ⇒ Object + + + + + +

    +
    +

    search:2. Used to fetch the next page of results.

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + cursor + + + (String) + + + + — +

      The cursor returned by your last call to

      +
      + +
    • + +
    + + +
    + + + + + +
    +
    +
    +
    +19
    +20
    +21
    +
    +
    # File 'lib/dropbox_api/endpoints/files/search_continue.rb', line 19
    +
    +add_endpoint :search_continue do |cursor|
    +  perform_request cursor: cursor
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Endpoints/Files/Upload.html b/docs/DropboxApi/Endpoints/Files/Upload.html index eb4e63e8..0f9dc83f 100644 --- a/docs/DropboxApi/Endpoints/Files/Upload.html +++ b/docs/DropboxApi/Endpoints/Files/Upload.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::Upload - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/upload".freeze
    +
    '/2/files/upload'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from ContentUpload

    -

    #build_request, #initialize, #perform_request

    +

    #build_connection, #build_request, #perform_request

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::ContentUpload

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -391,7 +391,6 @@

     
     
    -49
     50
     51
     52
    @@ -402,10 +401,11 @@ 

    57 58 59 -60

    +60 +61

    -
    # File 'lib/dropbox_api/endpoints/files/upload.rb', line 49
    +      
    # File 'lib/dropbox_api/endpoints/files/upload.rb', line 50
     
     add_endpoint :upload do |path, content, options = {}|
       validate_options([
    @@ -429,9 +429,9 @@ 

    diff --git a/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html b/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html index 860511ee..11165b24 100644 --- a/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html +++ b/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::UploadSessionAppendV2 - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/upload_session/append_v2".freeze
    +
    '/2/files/upload_session/append_v2'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from ContentUpload

    -

    #build_request, #initialize, #perform_request

    +

    #build_connection, #build_request, #perform_request

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::ContentUpload

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -331,7 +331,6 @@

     
     
    -38
     39
     40
     41
    @@ -341,10 +340,11 @@ 

    45 46 47 -48

    +48 +49

    -
    # File 'lib/dropbox_api/endpoints/files/upload_session_append_v2.rb', line 38
    +      
    # File 'lib/dropbox_api/endpoints/files/upload_session_append_v2.rb', line 39
     
     add_endpoint :upload_session_append_v2 do |cursor, content, options = {}|
       validate_options([
    @@ -352,7 +352,7 @@ 

    ], options) perform_request(options.merge({ - :cursor => cursor.to_hash + cursor: cursor.to_hash }), content) cursor.offset += content.bytesize @@ -367,9 +367,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/UploadSessionFinish.html b/docs/DropboxApi/Endpoints/Files/UploadSessionFinish.html index 5c38fbdf..c8545f97 100644 --- a/docs/DropboxApi/Endpoints/Files/UploadSessionFinish.html +++ b/docs/DropboxApi/Endpoints/Files/UploadSessionFinish.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::UploadSessionFinish - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/upload_session/finish".freeze
    +
    '/2/files/upload_session/finish'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from ContentUpload

    -

    #build_request, #initialize, #perform_request

    +

    #build_connection, #build_request, #perform_request

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::ContentUpload

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -292,20 +292,20 @@

     
     
    -21
     22
     23
     24
     25
    -26
    +26 +27

    -
    # File 'lib/dropbox_api/endpoints/files/upload_session_finish.rb', line 21
    +      
    # File 'lib/dropbox_api/endpoints/files/upload_session_finish.rb', line 22
     
     add_endpoint :upload_session_finish do |cursor, commit, content = nil|
       perform_request({
    -    :cursor => cursor.to_hash,
    -    :commit => commit.to_hash
    +    cursor: cursor.to_hash,
    +    commit: commit.to_hash
       }, content)
     end
    @@ -318,9 +318,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Files/UploadSessionStart.html b/docs/DropboxApi/Endpoints/Files/UploadSessionStart.html index b58fb40d..08ecd9c4 100644 --- a/docs/DropboxApi/Endpoints/Files/UploadSessionStart.html +++ b/docs/DropboxApi/Endpoints/Files/UploadSessionStart.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Files::UploadSessionStart - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/files/upload_session/start".freeze
    +
    '/2/files/upload_session/start'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from ContentUpload

    -

    #build_request, #initialize, #perform_request

    +

    #build_connection, #build_request, #perform_request

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::ContentUpload

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -302,7 +302,6 @@

     
     
    -25
     26
     27
     28
    @@ -313,10 +312,11 @@ 

    33 34 35 -36

    +36 +37

    -
    # File 'lib/dropbox_api/endpoints/files/upload_session_start.rb', line 25
    +      
    # File 'lib/dropbox_api/endpoints/files/upload_session_start.rb', line 26
     
     add_endpoint :upload_session_start do |content, options = {}|
       validate_options([
    @@ -326,8 +326,8 @@ 

    session = perform_request(options, content) DropboxApi::Metadata::UploadSessionCursor.new({ - "session_id" => session.session_id, - "offset" => content.bytesize + 'session_id' => session.session_id, + 'offset' => content.bytesize }) end

    @@ -340,9 +340,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Rpc.html b/docs/DropboxApi/Endpoints/Rpc.html index 1edd0884..c898cf29 100644 --- a/docs/DropboxApi/Endpoints/Rpc.html +++ b/docs/DropboxApi/Endpoints/Rpc.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Rpc - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -103,7 +103,7 @@

    Direct Known Subclasses

    -

    Auth::TokenRevoke, Files::Copy, Files::CopyBatch, Files::CopyBatchCheck, Files::CopyReferenceGet, Files::CopyReferenceSave, Files::CreateFileRequest, Files::CreateFolder, Files::CreateFolderBatch, Files::CreateFolderBatchCheck, Files::Delete, Files::DeleteBatch, Files::DeleteBatchCheck, Files::GetMetadata, Files::GetTemporaryLink, Files::ListFolder, Files::ListFolderContinue, Files::ListFolderGetLatestCursor, Files::ListRevisions, Files::Move, Files::PermanentlyDelete, Files::Restore, Files::SaveUrl, Files::SaveUrlCheckJobStatus, Files::Search, RpcContent, RpcNotify, Sharing::AddFileMember, Sharing::AddFolderMember, Sharing::CreateSharedLinkWithSettings, Sharing::GetSharedLinkMetadata, Sharing::ListFileMembers, Sharing::ListFolderMembers, Sharing::ListSharedLinks, Sharing::RevokeSharedLink, Sharing::ShareFolder, Sharing::UnshareFile, Users::GetAccount, Users::GetAccountBatch, Users::GetCurrentAccount, Users::GetSpaceUsage

    +

    Auth::TokenRevoke, Files::Copy, Files::CopyBatch, Files::CopyBatchCheck, Files::CopyReferenceGet, Files::CopyReferenceSave, Files::CreateFileRequest, Files::CreateFolder, Files::CreateFolderBatch, Files::CreateFolderBatchCheck, Files::Delete, Files::DeleteBatch, Files::DeleteBatchCheck, Files::GetMetadata, Files::GetTemporaryLink, Files::ListFolder, Files::ListFolderContinue, Files::ListFolderGetLatestCursor, Files::ListRevisions, Files::Move, Files::PermanentlyDelete, Files::Restore, Files::SaveUrl, Files::SaveUrlCheckJobStatus, Files::Search, Files::SearchContinue, RpcContent, RpcNotify, Sharing::AddFileMember, Sharing::AddFolderMember, Sharing::CreateSharedLinkWithSettings, Sharing::GetSharedLinkMetadata, Sharing::ListFileMembers, Sharing::ListFolderMembers, Sharing::ListSharedLinks, Sharing::RevokeSharedLink, Sharing::ShareFolder, Sharing::UnshareFile, Users::GetAccount, Users::GetAccountBatch, Users::GetCurrentAccount, Users::GetSpaceUsage

    @@ -123,7 +123,7 @@

  • - #build_request(params) ⇒ Object + #build_connection ⇒ Object @@ -145,15 +145,13 @@

  • - #initialize(builder) ⇒ Rpc + #build_request(params) ⇒ Object - constructor - @@ -161,8 +159,7 @@

    -

    A new instance of Rpc.

    -
    +

  • @@ -202,47 +199,46 @@

    Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -
    -

    - - #initialize(builder) ⇒ Rpc +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    +

    - - -
  • -
    -

    Returns a new instance of Rpc

    +
    +

    Instance Method Details

    + +
    +

    + + #build_connectionObject + -

    -
    -
    -
    + +

     
     
    -3
     4
     5
     6
    -7
    +7 +8
    -
    # File 'lib/dropbox_api/endpoints/rpc.rb', line 3
    +      
    # File 'lib/dropbox_api/endpoints/rpc.rb', line 4
     
    -def initialize(builder)
    -  @connection = builder.build("https://api.dropboxapi.com") do |c|
    +def build_connection
    +  @connection = @builder.build('https://api.dropboxapi.com') do |c|
         c.response :decode_result
       end
     end
    @@ -250,16 +246,9 @@

    - - - - -
    -

    Instance Method Details

    - -
    -

    +
    +

    #build_request(params) ⇒ Object @@ -274,16 +263,16 @@

     
     
    -9
     10
     11
     12
     13
     14
    -15
    +15 +16 -
    # File 'lib/dropbox_api/endpoints/rpc.rb', line 9
    +      
    # File 'lib/dropbox_api/endpoints/rpc.rb', line 10
     
     def build_request(params)
       request_headers = {
    @@ -313,17 +302,17 @@ 

     
     
    -17
     18
     19
     20
     21
     22
     23
    -24
    +24 +25

    -
    # File 'lib/dropbox_api/endpoints/rpc.rb', line 17
    +      
    # File 'lib/dropbox_api/endpoints/rpc.rb', line 18
     
     def request_body(params)
       # This check is only required for compatibility with old JSON serializers
    @@ -343,9 +332,9 @@ 

    diff --git a/docs/DropboxApi/Endpoints/RpcContent.html b/docs/DropboxApi/Endpoints/RpcContent.html index 2318cfc5..391c9645 100644 --- a/docs/DropboxApi/Endpoints/RpcContent.html +++ b/docs/DropboxApi/Endpoints/RpcContent.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::RpcContent - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,15 +125,13 @@

  • - #initialize(builder) ⇒ RpcContent + #build_connection ⇒ Object - constructor - @@ -141,8 +139,7 @@

    -

    A new instance of RpcContent.

    -
    +

  • @@ -171,47 +168,46 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -
    -

    - - #initialize(builder) ⇒ RpcContent +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    +

    - - -

    -
    -

    Returns a new instance of RpcContent

    +
    +

    Instance Method Details

    + +
    +

    + + #build_connectionObject + -

    -
    -
    -
    + +
     
     
    -3
     4
     5
     6
    -7
    +7 +8
    -
    # File 'lib/dropbox_api/endpoints/rpc_content.rb', line 3
    +      
    # File 'lib/dropbox_api/endpoints/rpc_content.rb', line 4
     
    -def initialize(builder)
    -  @connection = builder.build("https://content.dropboxapi.com") do |c|
    +def build_connection
    +  @connection = @builder.build('https://content.dropboxapi.com') do |c|
         c.response :decode_result
       end
     end
    @@ -219,16 +215,15 @@

    - -
    - + + diff --git a/docs/DropboxApi/Endpoints/RpcNotify.html b/docs/DropboxApi/Endpoints/RpcNotify.html index 993d414a..32d56035 100644 --- a/docs/DropboxApi/Endpoints/RpcNotify.html +++ b/docs/DropboxApi/Endpoints/RpcNotify.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::RpcNotify - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,15 +125,13 @@

  • - #initialize(builder) ⇒ RpcNotify + #build_connection ⇒ Object - constructor - @@ -141,8 +139,7 @@

    -

    A new instance of RpcNotify.

    -
    +

  • @@ -171,49 +168,48 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -
    -

    - - #initialize(builder) ⇒ RpcNotify +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    +

    - - -
    -
    -

    Returns a new instance of RpcNotify

    +
    +

    Instance Method Details

    + +
    +

    + + #build_connectionObject + -

    -
    -
    -
    + +
     
     
    -3
     4
     5
     6
     7
     8
    -9
    +9 +10
    -
    # File 'lib/dropbox_api/endpoints/rpc_notify.rb', line 3
    +      
    # File 'lib/dropbox_api/endpoints/rpc_notify.rb', line 4
     
    -def initialize(builder)
    -  @connection = builder.build("https://notify.dropboxapi.com") do |c|
    +def build_connection
    +  @connection = @builder.build('https://notify.dropboxapi.com') do |c|
         c.headers.delete 'Authorization'
     
         c.response :decode_result
    @@ -223,16 +219,15 @@ 

    - -
    - + +
    diff --git a/docs/DropboxApi/Endpoints/Sharing.html b/docs/DropboxApi/Endpoints/Sharing.html index 38502885..31367421 100644 --- a/docs/DropboxApi/Endpoints/Sharing.html +++ b/docs/DropboxApi/Endpoints/Sharing.html @@ -6,15 +6,15 @@ Module: DropboxApi::Endpoints::Sharing - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -107,9 +107,9 @@

    Defined Under Namespace

    diff --git a/docs/DropboxApi/Endpoints/Sharing/AddFileMember.html b/docs/DropboxApi/Endpoints/Sharing/AddFileMember.html index dad81468..106830a0 100644 --- a/docs/DropboxApi/Endpoints/Sharing/AddFileMember.html +++ b/docs/DropboxApi/Endpoints/Sharing/AddFileMember.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Sharing::AddFileMember - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/sharing/add_file_member".freeze
    +
    '/2/sharing/add_file_member'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -367,7 +367,6 @@

     
     
    -33
     34
     35
     36
    @@ -378,10 +377,11 @@ 

    41 42 43 -44

    +44 +45 -
    # File 'lib/dropbox_api/endpoints/sharing/add_file_member.rb', line 33
    +      
    # File 'lib/dropbox_api/endpoints/sharing/add_file_member.rb', line 34
     
     add_endpoint :add_file_member do |file, members, options = {}|
       validate_options([:quiet, :custom_message, :access_level, :add_message_as_comment], options)
    @@ -391,8 +391,8 @@ 

    options[:add_message_as_comment] ||= false perform_request options.merge({ - :file => file, - :members => build_members_param(members) + file: file, + members: build_members_param(members) }) end

    @@ -405,9 +405,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Sharing/AddFolderMember.html b/docs/DropboxApi/Endpoints/Sharing/AddFolderMember.html index 0ca47a94..f57bd99b 100644 --- a/docs/DropboxApi/Endpoints/Sharing/AddFolderMember.html +++ b/docs/DropboxApi/Endpoints/Sharing/AddFolderMember.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Sharing::AddFolderMember - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/sharing/add_folder_member".freeze
    +
    '/2/sharing/add_folder_member'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -356,7 +356,6 @@

     
     
    -38
     39
     40
     41
    @@ -365,10 +364,11 @@ 

    44 45 46 -47

    +47 +48

    -
    # File 'lib/dropbox_api/endpoints/sharing/add_folder_member.rb', line 38
    +      
    # File 'lib/dropbox_api/endpoints/sharing/add_folder_member.rb', line 39
     
     add_endpoint :add_folder_member do |folder_id, members, options = {}|
       validate_options([:quiet, :custom_message], options)
    @@ -376,8 +376,8 @@ 

    options[:custom_message] ||= nil perform_request options.merge({ - :shared_folder_id => folder_id.to_s, - :members => build_members_param(members) + shared_folder_id: folder_id.to_s, + members: build_members_param(members) }) end

    @@ -390,9 +390,9 @@

    diff --git a/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html b/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html index 39ac53ee..e4c7a1a5 100644 --- a/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html +++ b/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html @@ -6,15 +6,15 @@ Class: DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -125,7 +125,7 @@

    Path =
    -
    "/2/sharing/create_shared_link_with_settings".freeze
    +
    '/2/sharing/create_shared_link_with_settings'
    ResultType = @@ -201,7 +201,7 @@

    Methods included from Methods inherited from Rpc

    -

    #build_request, #initialize, #request_body

    +

    #build_connection, #build_request, #request_body

    @@ -212,11 +212,11 @@

    Methods inherited from Methods inherited from Base

    -

    add_endpoint

    +

    add_endpoint, #initialize

    Constructor Details

    -

    This class inherits a constructor from DropboxApi::Endpoints::Rpc

    +

    This class inherits a constructor from DropboxApi::Endpoints::Base

    @@ -359,7 +359,6 @@
    {
    -  :user_error => SharingUserError,
    -  :access_error => SharingFileAccessError,
    -  :rate_limit => RateLimitError,
    -  :invalid_comment => InvalidCommentError
    +  user_error: SharingUserError,
    +  access_error: SharingFileAccessError,
    +  rate_limit: RateLimitError,
    +  invalid_comment: InvalidCommentError
     }.freeze
    @@ -154,9 +154,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/AddFolderMemberError.html b/docs/DropboxApi/Errors/AddFolderMemberError.html index a59e6cc9..4ba7fc6a 100644 --- a/docs/DropboxApi/Errors/AddFolderMemberError.html +++ b/docs/DropboxApi/Errors/AddFolderMemberError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::AddFolderMemberError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,16 +116,16 @@

    {
    -  :access_error => SharedFolderAccessError,
    -  :email_unverified => EmailUnverifiedError,
    -  :bad_member => AddMemberSelectorError,
    -  :cant_share_outside_team => CantShareOutsideTeamError,
    -  :too_many_members => TooManyMembersError,
    -  :too_many_pending_invites => TooManyPendingInvitesError,
    -  :rate_limit => RateLimitError,
    -  :insufficient_plan => InsufficientPlanError,
    -  :team_folder => TeamFolderError,
    -  :no_permission => NoPermissionError
    +  access_error: SharedFolderAccessError,
    +  email_unverified: EmailUnverifiedError,
    +  bad_member: AddMemberSelectorError,
    +  cant_share_outside_team: CantShareOutsideTeamError,
    +  too_many_members: TooManyMembersError,
    +  too_many_pending_invites: TooManyPendingInvitesError,
    +  rate_limit: RateLimitError,
    +  insufficient_plan: InsufficientPlanError,
    +  team_folder: TeamFolderError,
    +  no_permission: NoPermissionError
     }.freeze
    @@ -160,9 +160,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/AddMemberSelectorError.html b/docs/DropboxApi/Errors/AddMemberSelectorError.html index 36ab3e72..bd2c50b1 100644 --- a/docs/DropboxApi/Errors/AddMemberSelectorError.html +++ b/docs/DropboxApi/Errors/AddMemberSelectorError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::AddMemberSelectorError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,11 +116,11 @@

    {
    -  :invalid_dropbox_id => InvalidDropboxIdError,
    -  :invalid_email => InvalidEmailError,
    -  :unverified_dropbox_id => UnverifiedDropboxId,
    -  :group_deleted => GroupDeletedError,
    -  :group_not_on_team => GroupNotOnTeamError
    +  invalid_dropbox_id: InvalidDropboxIdError,
    +  invalid_email: InvalidEmailError,
    +  unverified_dropbox_id: UnverifiedDropboxId,
    +  group_deleted: GroupDeletedError,
    +  group_not_on_team: GroupNotOnTeamError
     }.freeze
    @@ -155,9 +155,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/AlreadySharedError.html b/docs/DropboxApi/Errors/AlreadySharedError.html index fc6ae74b..1421fc94 100644 --- a/docs/DropboxApi/Errors/AlreadySharedError.html +++ b/docs/DropboxApi/Errors/AlreadySharedError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::AlreadySharedError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -183,12 +183,12 @@

     
     
    -3
     4
    -5
    +5 +6 -
    # File 'lib/dropbox_api/errors/already_shared_error.rb', line 3
    +      
    # File 'lib/dropbox_api/errors/already_shared_error.rb', line 4
     
     def shared_folder
       DropboxApi::Metadata::SharedFolder.new @metadata
    @@ -203,9 +203,9 @@ 

    diff --git a/docs/DropboxApi/Errors/BadPathError.html b/docs/DropboxApi/Errors/BadPathError.html index a0df1f89..860b5528 100644 --- a/docs/DropboxApi/Errors/BadPathError.html +++ b/docs/DropboxApi/Errors/BadPathError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::BadPathError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/BasicError.html b/docs/DropboxApi/Errors/BasicError.html index 6bc18c67..9adc1f0c 100644 --- a/docs/DropboxApi/Errors/BasicError.html +++ b/docs/DropboxApi/Errors/BasicError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::BasicError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -103,7 +103,7 @@

    Direct Known Subclasses

    -

    AddFileMemberError, AddFolderMemberError, AddMemberSelectorError, AlreadySharedError, BadPathError, CantCopySharedFolderError, CantMoveFolderIntoItselfError, CantNestSharedFolderError, CantShareOutsideTeamError, ContainsSharedFolderError, ConversionError, CreateFileRequestError, CreateFolderBatchError, CreateFolderError, CreateSharedLinkWithSettingsError, CursorClosedError, CursorNotClosedError, DeleteError, DisallowedNameError, DisallowedSharedLinkPolicyError, DownloadError, DownloadFailedError, EmailUnverifiedError, FileAncestorConflictError, FileConflictError, FileMemberActionError, FolderConflictError, GetAccountError, GetCopyReferenceError, GetMetadataError, GroupDeletedError, GroupNotOnTeamError, InProgressError, InsideAppFolderError, InsideOsxPackageError, InsidePublicFolderError, InsideSharedFolderError, InsufficientPlanError, InsufficientSpaceError, InternalError, InvalidCommentError, InvalidCopyReferenceError, InvalidCursorError, InvalidDropboxIdError, InvalidEmailError, InvalidFileError, InvalidIdError, InvalidMemberError, InvalidPathError, InvalidRevisionError, InvalidSettingsError, InvalidUrlError, IsAppFolderError, IsFileError, IsFolderError, IsOsxPackageError, IsPublicFolderError, ListFolderContinueError, ListFolderError, ListFolderLongpollError, ListRevisionsError, ListSharedLinksError, LookupError, MalformedPathError, NoAccountError, NoPermissionError, NoWritePermissionError, NotAMemberError, NotFileError, NotFolderError, NotFoundError, PollError, PreviewError, RateLimitError, RelocationBatchEntryError, RelocationError, RestoreError, RestrictedContentError, RevokeSharedLinkError, SaveCopyReferenceError, SaveUrlError, SearchError, SettingsError, ShareFolderError, SharePathError, SharedFolderAccessError, SharedLinkAccessDeniedError, SharedLinkAlreadyExistsError, SharedLinkError, SharedLinkMalformedError, SharedLinkNotFoundError, SharingFileAccessError, SharingUserError, TeamFolderError, TeamPolicyDisallowsMemberPolicyError, ThumbnailBatchError, ThumbnailError, TooManyFilesError, TooManyMembersError, TooManyPendingInvitesError, TooManyRequestsError, TooManySharedFolderTargetsError, UnmountedError, UnshareFileError, UnsupportedContentError, UnsupportedExtensionError, UnsupportedImageError, UnsupportedLinkTypeError, UnverifiedDropboxId, UploadError, UploadSessionFinishError, UploadSessionLookupError, UploadSessionOffsetError, UploadWriteFailedError, WriteConflictError, WriteError

    +

    AddFileMemberError, AddFolderMemberError, AddMemberSelectorError, AlreadySharedError, BadPathError, CantCopySharedFolderError, CantMoveFolderIntoItselfError, CantNestSharedFolderError, CantShareOutsideTeamError, ContainsSharedFolderError, ConversionError, CreateFileRequestError, CreateFolderBatchError, CreateFolderError, CreateSharedLinkWithSettingsError, CursorClosedError, CursorNotClosedError, DeleteError, DisallowedNameError, DisallowedSharedLinkPolicyError, DownloadError, DownloadFailedError, EmailUnverifiedError, ExpiredAccessTokenError, FileAncestorConflictError, FileConflictError, FileMemberActionError, FolderConflictError, GetAccountError, GetCopyReferenceError, GetMetadataError, GroupDeletedError, GroupNotOnTeamError, InProgressError, InsideAppFolderError, InsideOsxPackageError, InsidePublicFolderError, InsideSharedFolderError, InsufficientPlanError, InsufficientSpaceError, InternalError, InvalidCommentError, InvalidCopyReferenceError, InvalidCursorError, InvalidDropboxIdError, InvalidEmailError, InvalidFileError, InvalidIdError, InvalidMemberError, InvalidPathError, InvalidRevisionError, InvalidSettingsError, InvalidUrlError, IsAppFolderError, IsFileError, IsFolderError, IsOsxPackageError, IsPublicFolderError, ListFolderContinueError, ListFolderError, ListFolderLongpollError, ListRevisionsError, ListSharedLinksError, LookupError, MalformedPathError, NoAccountError, NoPermissionError, NoWritePermissionError, NotAMemberError, NotFileError, NotFolderError, NotFoundError, PollError, PreviewError, RateLimitError, RelocationBatchEntryError, RelocationError, RestoreError, RestrictedContentError, RevokeSharedLinkError, SaveCopyReferenceError, SaveUrlError, SearchError, SettingsError, ShareFolderError, SharePathError, SharedFolderAccessError, SharedLinkAccessDeniedError, SharedLinkAlreadyExistsError, SharedLinkError, SharedLinkMalformedError, SharedLinkNotFoundError, SharingFileAccessError, SharingUserError, TeamFolderError, TeamPolicyDisallowsMemberPolicyError, ThumbnailBatchError, ThumbnailError, TooManyFilesError, TooManyMembersError, TooManyPendingInvitesError, TooManyRequestsError, TooManySharedFolderTargetsError, UnmountedError, UnshareFileError, UnsupportedContentError, UnsupportedExtensionError, UnsupportedImageError, UnsupportedLinkTypeError, UnverifiedDropboxId, UploadError, UploadSessionFinishError, UploadSessionLookupError, UploadSessionOffsetError, UploadWriteFailedError, WriteConflictError, WriteError

    @@ -216,7 +216,7 @@

    -

    Returns a new instance of BasicError

    +

    Returns a new instance of BasicError.

    @@ -231,13 +231,13 @@

     
     
    -3
     4
     5
    -6
    +6 +7

    -
    # File 'lib/dropbox_api/errors/basic_error.rb', line 3
    +      
    # File 'lib/dropbox_api/errors/basic_error.rb', line 4
     
     def initialize(message, )
       @metadata = 
    @@ -271,7 +271,6 @@ 

     
     
    -9
     10
     11
     12
    @@ -279,10 +278,11 @@ 

    14 15 16 -17

    +17 +18

    -
    # File 'lib/dropbox_api/errors/basic_error.rb', line 9
    +      
    # File 'lib/dropbox_api/errors/basic_error.rb', line 10
     
     def build(message, )
       subtype,  = find_subtype 
    @@ -314,7 +314,6 @@ 

     
     
    -19
     20
     21
     22
    @@ -322,14 +321,15 @@ 

    24 25 26 -27

    +27 +28

    -
    # File 'lib/dropbox_api/errors/basic_error.rb', line 19
    +      
    # File 'lib/dropbox_api/errors/basic_error.rb', line 20
     
     def find_subtype()
       if defined? self::ErrorSubtypes
    -    discriminator = [".tag"]
    +    discriminator = ['.tag']
          = [discriminator] unless [discriminator].nil?
         [self::ErrorSubtypes[discriminator.to_sym], ]
       else
    @@ -346,9 +346,9 @@ 

    diff --git a/docs/DropboxApi/Errors/CantCopySharedFolderError.html b/docs/DropboxApi/Errors/CantCopySharedFolderError.html index 71ac0a57..cdcf25c8 100644 --- a/docs/DropboxApi/Errors/CantCopySharedFolderError.html +++ b/docs/DropboxApi/Errors/CantCopySharedFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::CantCopySharedFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError.html b/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError.html index ff2bbbab..0726f41e 100644 --- a/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError.html +++ b/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::CantMoveFolderIntoItselfError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/CantNestSharedFolderError.html b/docs/DropboxApi/Errors/CantNestSharedFolderError.html index 8a7ed9dd..a90e3946 100644 --- a/docs/DropboxApi/Errors/CantNestSharedFolderError.html +++ b/docs/DropboxApi/Errors/CantNestSharedFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::CantNestSharedFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/CantShareOutsideTeamError.html b/docs/DropboxApi/Errors/CantShareOutsideTeamError.html index fd12cfa0..ee0ad477 100644 --- a/docs/DropboxApi/Errors/CantShareOutsideTeamError.html +++ b/docs/DropboxApi/Errors/CantShareOutsideTeamError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::CantShareOutsideTeamError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/ContainsSharedFolderError.html b/docs/DropboxApi/Errors/ContainsSharedFolderError.html index af0f9a47..a58cd580 100644 --- a/docs/DropboxApi/Errors/ContainsSharedFolderError.html +++ b/docs/DropboxApi/Errors/ContainsSharedFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::ContainsSharedFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/ConversionError.html b/docs/DropboxApi/Errors/ConversionError.html index e8b70d5d..f6b2c653 100644 --- a/docs/DropboxApi/Errors/ConversionError.html +++ b/docs/DropboxApi/Errors/ConversionError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::ConversionError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/CreateFileRequestError.html b/docs/DropboxApi/Errors/CreateFileRequestError.html index 3fe42040..15ae6495 100644 --- a/docs/DropboxApi/Errors/CreateFileRequestError.html +++ b/docs/DropboxApi/Errors/CreateFileRequestError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::CreateFileRequestError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -150,9 +150,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/CreateFolderBatchError.html b/docs/DropboxApi/Errors/CreateFolderBatchError.html index 9540f1a9..133d5bed 100644 --- a/docs/DropboxApi/Errors/CreateFolderBatchError.html +++ b/docs/DropboxApi/Errors/CreateFolderBatchError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::CreateFolderBatchError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :too_many_files => TooManyFilesError
    +  too_many_files: TooManyFilesError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/CreateFolderError.html b/docs/DropboxApi/Errors/CreateFolderError.html index b139ab66..5aa5907f 100644 --- a/docs/DropboxApi/Errors/CreateFolderError.html +++ b/docs/DropboxApi/Errors/CreateFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::CreateFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :path => WriteError
    +  path: WriteError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html b/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html index 845b7f76..a4759964 100644 --- a/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html +++ b/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::CreateSharedLinkWithSettingsError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,11 +116,11 @@

    {
    -  :path => LookupError,
    -  :email_not_verified => EmailUnverifiedError,
    -  :shared_link_already_exists => SharedLinkAlreadyExistsError,
    -  :settings_error => SettingsError,
    -  :access_denied => NoPermissionError
    +  path: LookupError,
    +  email_not_verified: EmailUnverifiedError,
    +  shared_link_already_exists: SharedLinkAlreadyExistsError,
    +  settings_error: SettingsError,
    +  access_denied: NoPermissionError
     }.freeze
    @@ -155,9 +155,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/CursorClosedError.html b/docs/DropboxApi/Errors/CursorClosedError.html index 499ec48f..6791995c 100644 --- a/docs/DropboxApi/Errors/CursorClosedError.html +++ b/docs/DropboxApi/Errors/CursorClosedError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::CursorClosedError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/CursorNotClosedError.html b/docs/DropboxApi/Errors/CursorNotClosedError.html index eb42655c..0e2e7553 100644 --- a/docs/DropboxApi/Errors/CursorNotClosedError.html +++ b/docs/DropboxApi/Errors/CursorNotClosedError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::CursorNotClosedError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/DeleteError.html b/docs/DropboxApi/Errors/DeleteError.html index 0bc20f47..f77116e7 100644 --- a/docs/DropboxApi/Errors/DeleteError.html +++ b/docs/DropboxApi/Errors/DeleteError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::DeleteError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,9 +116,9 @@

    {
    -  :path_lookup => LookupError,
    -  :path_write => WriteError,
    -  :too_many_write_operations => TooManyWriteOperationsError
    +  path_lookup: LookupError,
    +  path_write: WriteError,
    +  too_many_write_operations: TooManyWriteOperationsError
     }.freeze
    @@ -153,9 +153,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/DisallowedNameError.html b/docs/DropboxApi/Errors/DisallowedNameError.html index c7265b56..6a87259c 100644 --- a/docs/DropboxApi/Errors/DisallowedNameError.html +++ b/docs/DropboxApi/Errors/DisallowedNameError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::DisallowedNameError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html b/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html index 8404dad7..8733d220 100644 --- a/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html +++ b/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::DisallowedSharedLinkPolicyError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/DownloadError.html b/docs/DropboxApi/Errors/DownloadError.html index eba26780..bc3ea570 100644 --- a/docs/DropboxApi/Errors/DownloadError.html +++ b/docs/DropboxApi/Errors/DownloadError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::DownloadError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :path => LookupError
    +  path: LookupError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/DownloadFailedError.html b/docs/DropboxApi/Errors/DownloadFailedError.html index 52bf2af3..223cf59f 100644 --- a/docs/DropboxApi/Errors/DownloadFailedError.html +++ b/docs/DropboxApi/Errors/DownloadFailedError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::DownloadFailedError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/EmailUnverifiedError.html b/docs/DropboxApi/Errors/EmailUnverifiedError.html index d412ebc5..7deb8b3d 100644 --- a/docs/DropboxApi/Errors/EmailUnverifiedError.html +++ b/docs/DropboxApi/Errors/EmailUnverifiedError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::EmailUnverifiedError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/ExpiredAccessTokenError.html b/docs/DropboxApi/Errors/ExpiredAccessTokenError.html new file mode 100644 index 00000000..5c26a024 --- /dev/null +++ b/docs/DropboxApi/Errors/ExpiredAccessTokenError.html @@ -0,0 +1,143 @@ + + + + + + + Exception: DropboxApi::Errors::ExpiredAccessTokenError + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Exception: DropboxApi::Errors::ExpiredAccessTokenError + + + +

    +
    + +
    +
    Inherits:
    +
    + BasicError + +
      +
    • Object
    • + + + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/errors/expired_access_token_error.rb
    +
    + +
    + + + + + + + + + + + + + + + +

    Method Summary

    + +

    Methods inherited from BasicError

    +

    build, find_subtype, #initialize

    + +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Errors::BasicError

    + +
    + + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Errors/FileAncestorConflictError.html b/docs/DropboxApi/Errors/FileAncestorConflictError.html index e458aff6..48e681ce 100644 --- a/docs/DropboxApi/Errors/FileAncestorConflictError.html +++ b/docs/DropboxApi/Errors/FileAncestorConflictError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::FileAncestorConflictError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/FileConflictError.html b/docs/DropboxApi/Errors/FileConflictError.html index 890cebf6..7347dbe1 100644 --- a/docs/DropboxApi/Errors/FileConflictError.html +++ b/docs/DropboxApi/Errors/FileConflictError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::FileConflictError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/FileMemberActionError.html b/docs/DropboxApi/Errors/FileMemberActionError.html index 467e61b0..c81eb25a 100644 --- a/docs/DropboxApi/Errors/FileMemberActionError.html +++ b/docs/DropboxApi/Errors/FileMemberActionError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::FileMemberActionError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,10 +116,10 @@

    {
    -  :invalid_member => InvalidMemberError,
    -  :no_permission => NoPermissionError,
    -  :access_error => SharingFileAccessError,
    -  :no_explicit_access => DropboxApi::Metadata::ParentFolderAccessInfo
    +  invalid_member: InvalidMemberError,
    +  no_permission: NoPermissionError,
    +  access_error: SharingFileAccessError,
    +  no_explicit_access: DropboxApi::Metadata::ParentFolderAccessInfo
     }.freeze
    @@ -154,9 +154,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/FolderConflictError.html b/docs/DropboxApi/Errors/FolderConflictError.html index c82b65a8..61eaec0a 100644 --- a/docs/DropboxApi/Errors/FolderConflictError.html +++ b/docs/DropboxApi/Errors/FolderConflictError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::FolderConflictError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/GetAccountError.html b/docs/DropboxApi/Errors/GetAccountError.html index e57e52f1..1e43d190 100644 --- a/docs/DropboxApi/Errors/GetAccountError.html +++ b/docs/DropboxApi/Errors/GetAccountError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::GetAccountError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :no_account => NoAccountError
    +  no_account: NoAccountError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/GetCopyReferenceError.html b/docs/DropboxApi/Errors/GetCopyReferenceError.html index c3715875..f71d078f 100644 --- a/docs/DropboxApi/Errors/GetCopyReferenceError.html +++ b/docs/DropboxApi/Errors/GetCopyReferenceError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::GetCopyReferenceError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :path => LookupError
    +  path: LookupError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/GetMetadataError.html b/docs/DropboxApi/Errors/GetMetadataError.html index d685a91b..8d7101c3 100644 --- a/docs/DropboxApi/Errors/GetMetadataError.html +++ b/docs/DropboxApi/Errors/GetMetadataError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::GetMetadataError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :path => LookupError
    +  path: LookupError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/GroupDeletedError.html b/docs/DropboxApi/Errors/GroupDeletedError.html index 5f677d01..281384e8 100644 --- a/docs/DropboxApi/Errors/GroupDeletedError.html +++ b/docs/DropboxApi/Errors/GroupDeletedError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::GroupDeletedError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/GroupNotOnTeamError.html b/docs/DropboxApi/Errors/GroupNotOnTeamError.html index 9576e757..01797a05 100644 --- a/docs/DropboxApi/Errors/GroupNotOnTeamError.html +++ b/docs/DropboxApi/Errors/GroupNotOnTeamError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::GroupNotOnTeamError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/HttpError.html b/docs/DropboxApi/Errors/HttpError.html index df61fee1..767ad0e3 100644 --- a/docs/DropboxApi/Errors/HttpError.html +++ b/docs/DropboxApi/Errors/HttpError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::HttpError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -114,9 +114,9 @@ diff --git a/docs/DropboxApi/Errors/InProgressError.html b/docs/DropboxApi/Errors/InProgressError.html index 498c3bf1..fb31dfbf 100644 --- a/docs/DropboxApi/Errors/InProgressError.html +++ b/docs/DropboxApi/Errors/InProgressError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InProgressError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InsideAppFolderError.html b/docs/DropboxApi/Errors/InsideAppFolderError.html index 1cbc5cd4..3624c2a6 100644 --- a/docs/DropboxApi/Errors/InsideAppFolderError.html +++ b/docs/DropboxApi/Errors/InsideAppFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InsideAppFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InsideOsxPackageError.html b/docs/DropboxApi/Errors/InsideOsxPackageError.html index bf80f3a4..86e2114b 100644 --- a/docs/DropboxApi/Errors/InsideOsxPackageError.html +++ b/docs/DropboxApi/Errors/InsideOsxPackageError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InsideOsxPackageError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InsidePublicFolderError.html b/docs/DropboxApi/Errors/InsidePublicFolderError.html index 712ef8e9..1a284cda 100644 --- a/docs/DropboxApi/Errors/InsidePublicFolderError.html +++ b/docs/DropboxApi/Errors/InsidePublicFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InsidePublicFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InsideSharedFolderError.html b/docs/DropboxApi/Errors/InsideSharedFolderError.html index 5c9c95f4..6847a497 100644 --- a/docs/DropboxApi/Errors/InsideSharedFolderError.html +++ b/docs/DropboxApi/Errors/InsideSharedFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InsideSharedFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InsufficientPlanError.html b/docs/DropboxApi/Errors/InsufficientPlanError.html index 33c668fe..38cd186a 100644 --- a/docs/DropboxApi/Errors/InsufficientPlanError.html +++ b/docs/DropboxApi/Errors/InsufficientPlanError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InsufficientPlanError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InsufficientSpaceError.html b/docs/DropboxApi/Errors/InsufficientSpaceError.html index f635c342..f10c126c 100644 --- a/docs/DropboxApi/Errors/InsufficientSpaceError.html +++ b/docs/DropboxApi/Errors/InsufficientSpaceError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InsufficientSpaceError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InternalError.html b/docs/DropboxApi/Errors/InternalError.html index 9c594af0..1d71578a 100644 --- a/docs/DropboxApi/Errors/InternalError.html +++ b/docs/DropboxApi/Errors/InternalError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InternalError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InvalidCommentError.html b/docs/DropboxApi/Errors/InvalidCommentError.html index 6e1b4126..8dff3b7c 100644 --- a/docs/DropboxApi/Errors/InvalidCommentError.html +++ b/docs/DropboxApi/Errors/InvalidCommentError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InvalidCommentError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InvalidCopyReferenceError.html b/docs/DropboxApi/Errors/InvalidCopyReferenceError.html index 9a8a3e1e..ae6fb621 100644 --- a/docs/DropboxApi/Errors/InvalidCopyReferenceError.html +++ b/docs/DropboxApi/Errors/InvalidCopyReferenceError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InvalidCopyReferenceError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InvalidCursorError.html b/docs/DropboxApi/Errors/InvalidCursorError.html index fe35c711..593848db 100644 --- a/docs/DropboxApi/Errors/InvalidCursorError.html +++ b/docs/DropboxApi/Errors/InvalidCursorError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InvalidCursorError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InvalidDropboxIdError.html b/docs/DropboxApi/Errors/InvalidDropboxIdError.html index b95a23c2..dc9f9ff3 100644 --- a/docs/DropboxApi/Errors/InvalidDropboxIdError.html +++ b/docs/DropboxApi/Errors/InvalidDropboxIdError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InvalidDropboxIdError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InvalidEmailError.html b/docs/DropboxApi/Errors/InvalidEmailError.html index 80ff06cb..92567a7b 100644 --- a/docs/DropboxApi/Errors/InvalidEmailError.html +++ b/docs/DropboxApi/Errors/InvalidEmailError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InvalidEmailError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InvalidFileError.html b/docs/DropboxApi/Errors/InvalidFileError.html index 75c70506..7974f815 100644 --- a/docs/DropboxApi/Errors/InvalidFileError.html +++ b/docs/DropboxApi/Errors/InvalidFileError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InvalidFileError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InvalidIdError.html b/docs/DropboxApi/Errors/InvalidIdError.html index 848bcf9b..2785a848 100644 --- a/docs/DropboxApi/Errors/InvalidIdError.html +++ b/docs/DropboxApi/Errors/InvalidIdError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InvalidIdError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InvalidMemberError.html b/docs/DropboxApi/Errors/InvalidMemberError.html index cfd07496..e05e58ef 100644 --- a/docs/DropboxApi/Errors/InvalidMemberError.html +++ b/docs/DropboxApi/Errors/InvalidMemberError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InvalidMemberError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InvalidPathError.html b/docs/DropboxApi/Errors/InvalidPathError.html index 50addc84..c0ce5b3a 100644 --- a/docs/DropboxApi/Errors/InvalidPathError.html +++ b/docs/DropboxApi/Errors/InvalidPathError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InvalidPathError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InvalidRevisionError.html b/docs/DropboxApi/Errors/InvalidRevisionError.html index 93a241d9..0de39d6a 100644 --- a/docs/DropboxApi/Errors/InvalidRevisionError.html +++ b/docs/DropboxApi/Errors/InvalidRevisionError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InvalidRevisionError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InvalidSettingsError.html b/docs/DropboxApi/Errors/InvalidSettingsError.html index 6bbb5440..9580141e 100644 --- a/docs/DropboxApi/Errors/InvalidSettingsError.html +++ b/docs/DropboxApi/Errors/InvalidSettingsError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InvalidSettingsError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/InvalidUrlError.html b/docs/DropboxApi/Errors/InvalidUrlError.html index d567afdc..1bd96132 100644 --- a/docs/DropboxApi/Errors/InvalidUrlError.html +++ b/docs/DropboxApi/Errors/InvalidUrlError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::InvalidUrlError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/IsAppFolderError.html b/docs/DropboxApi/Errors/IsAppFolderError.html index 2b0a7171..82bc5ded 100644 --- a/docs/DropboxApi/Errors/IsAppFolderError.html +++ b/docs/DropboxApi/Errors/IsAppFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::IsAppFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/IsFileError.html b/docs/DropboxApi/Errors/IsFileError.html index 8798d756..13ccd2e1 100644 --- a/docs/DropboxApi/Errors/IsFileError.html +++ b/docs/DropboxApi/Errors/IsFileError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::IsFileError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/IsFolderError.html b/docs/DropboxApi/Errors/IsFolderError.html index ad27d7b7..707e8f9c 100644 --- a/docs/DropboxApi/Errors/IsFolderError.html +++ b/docs/DropboxApi/Errors/IsFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::IsFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/IsOsxPackageError.html b/docs/DropboxApi/Errors/IsOsxPackageError.html index 36585dc2..8baafeb3 100644 --- a/docs/DropboxApi/Errors/IsOsxPackageError.html +++ b/docs/DropboxApi/Errors/IsOsxPackageError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::IsOsxPackageError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/IsPublicFolderError.html b/docs/DropboxApi/Errors/IsPublicFolderError.html index cfe6fad0..f2a525f5 100644 --- a/docs/DropboxApi/Errors/IsPublicFolderError.html +++ b/docs/DropboxApi/Errors/IsPublicFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::IsPublicFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/ListFolderContinueError.html b/docs/DropboxApi/Errors/ListFolderContinueError.html index 6eb9af5d..a255c725 100644 --- a/docs/DropboxApi/Errors/ListFolderContinueError.html +++ b/docs/DropboxApi/Errors/ListFolderContinueError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::ListFolderContinueError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,8 +116,8 @@

    {
    -  :path => WriteError,
    -  :reset => InvalidCursorError
    +  path: WriteError,
    +  reset: InvalidCursorError
     }.freeze
    @@ -152,9 +152,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/ListFolderError.html b/docs/DropboxApi/Errors/ListFolderError.html index 18427399..f8e9b2b3 100644 --- a/docs/DropboxApi/Errors/ListFolderError.html +++ b/docs/DropboxApi/Errors/ListFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::ListFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :path => LookupError
    +  path: LookupError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/ListFolderLongpollError.html b/docs/DropboxApi/Errors/ListFolderLongpollError.html index 8813af7c..3f066733 100644 --- a/docs/DropboxApi/Errors/ListFolderLongpollError.html +++ b/docs/DropboxApi/Errors/ListFolderLongpollError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::ListFolderLongpollError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :reset => InvalidCursorError
    +  reset: InvalidCursorError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/ListRevisionsError.html b/docs/DropboxApi/Errors/ListRevisionsError.html index 9ac7b7e8..970dcb56 100644 --- a/docs/DropboxApi/Errors/ListRevisionsError.html +++ b/docs/DropboxApi/Errors/ListRevisionsError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::ListRevisionsError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :path => LookupError
    +  path: LookupError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/ListSharedLinksError.html b/docs/DropboxApi/Errors/ListSharedLinksError.html index ea7e329c..d245bdcd 100644 --- a/docs/DropboxApi/Errors/ListSharedLinksError.html +++ b/docs/DropboxApi/Errors/ListSharedLinksError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::ListSharedLinksError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,8 +116,8 @@

    {
    -  :path => LookupError,
    -  :reset => InvalidCursorError
    +  path: LookupError,
    +  reset: InvalidCursorError
     }.freeze
    @@ -152,9 +152,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/LookupError.html b/docs/DropboxApi/Errors/LookupError.html index 5428ef84..d41524de 100644 --- a/docs/DropboxApi/Errors/LookupError.html +++ b/docs/DropboxApi/Errors/LookupError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::LookupError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,11 +116,11 @@

    {
    -  :malformed_path => MalformedPathError,
    -  :not_found => NotFoundError,
    -  :not_file => NotFileError,
    -  :not_folder => NotFolderError,
    -  :restricted_content => RestrictedContentError
    +  malformed_path: MalformedPathError,
    +  not_found: NotFoundError,
    +  not_file: NotFileError,
    +  not_folder: NotFolderError,
    +  restricted_content: RestrictedContentError
     }.freeze
    @@ -155,9 +155,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/MalformedPathError.html b/docs/DropboxApi/Errors/MalformedPathError.html index d2caa21c..d75bb1c3 100644 --- a/docs/DropboxApi/Errors/MalformedPathError.html +++ b/docs/DropboxApi/Errors/MalformedPathError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::MalformedPathError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/NoAccountError.html b/docs/DropboxApi/Errors/NoAccountError.html index eae809e0..06fca1bb 100644 --- a/docs/DropboxApi/Errors/NoAccountError.html +++ b/docs/DropboxApi/Errors/NoAccountError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::NoAccountError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/NoPermissionError.html b/docs/DropboxApi/Errors/NoPermissionError.html index f86c9921..d807a72f 100644 --- a/docs/DropboxApi/Errors/NoPermissionError.html +++ b/docs/DropboxApi/Errors/NoPermissionError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::NoPermissionError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/NoWritePermissionError.html b/docs/DropboxApi/Errors/NoWritePermissionError.html index 44d6d477..da72ebe5 100644 --- a/docs/DropboxApi/Errors/NoWritePermissionError.html +++ b/docs/DropboxApi/Errors/NoWritePermissionError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::NoWritePermissionError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/NotAMemberError.html b/docs/DropboxApi/Errors/NotAMemberError.html index 6a182314..318c8f43 100644 --- a/docs/DropboxApi/Errors/NotAMemberError.html +++ b/docs/DropboxApi/Errors/NotAMemberError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::NotAMemberError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/NotFileError.html b/docs/DropboxApi/Errors/NotFileError.html index ba85f112..2c0608a3 100644 --- a/docs/DropboxApi/Errors/NotFileError.html +++ b/docs/DropboxApi/Errors/NotFileError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::NotFileError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/NotFolderError.html b/docs/DropboxApi/Errors/NotFolderError.html index e80a7a05..e7252516 100644 --- a/docs/DropboxApi/Errors/NotFolderError.html +++ b/docs/DropboxApi/Errors/NotFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::NotFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/NotFoundError.html b/docs/DropboxApi/Errors/NotFoundError.html index b1063aee..78a5b525 100644 --- a/docs/DropboxApi/Errors/NotFoundError.html +++ b/docs/DropboxApi/Errors/NotFoundError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::NotFoundError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/PollError.html b/docs/DropboxApi/Errors/PollError.html index 8e5ecfb0..106c92b5 100644 --- a/docs/DropboxApi/Errors/PollError.html +++ b/docs/DropboxApi/Errors/PollError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::PollError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,8 +116,8 @@

    {
    -  :invalid_async_job_id => InvalidIdError,
    -  :internal_error => InternalError
    +  invalid_async_job_id: InvalidIdError,
    +  internal_error: InternalError
     }.freeze
    @@ -152,9 +152,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/PreviewError.html b/docs/DropboxApi/Errors/PreviewError.html index 3a964e5f..8c72002e 100644 --- a/docs/DropboxApi/Errors/PreviewError.html +++ b/docs/DropboxApi/Errors/PreviewError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::PreviewError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,10 +116,10 @@

    {
    -  :path => LookupError,
    -  :in_progress => InProgressError,
    -  :unsupported_extension => UnsupportedExtensionError,
    -  :unsupported_content => UnsupportedContentError
    +  path: LookupError,
    +  in_progress: InProgressError,
    +  unsupported_extension: UnsupportedExtensionError,
    +  unsupported_content: UnsupportedContentError
     }.freeze
    @@ -154,9 +154,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/RateLimitError.html b/docs/DropboxApi/Errors/RateLimitError.html index 468448b7..e716bbdd 100644 --- a/docs/DropboxApi/Errors/RateLimitError.html +++ b/docs/DropboxApi/Errors/RateLimitError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::RateLimitError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/RelocationBatchEntryError.html b/docs/DropboxApi/Errors/RelocationBatchEntryError.html index eef7aa8b..2df4198a 100644 --- a/docs/DropboxApi/Errors/RelocationBatchEntryError.html +++ b/docs/DropboxApi/Errors/RelocationBatchEntryError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::RelocationBatchEntryError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,9 +116,9 @@

    {
    -  :relocation_error => RelocationError,
    -  :internal_error => InternalError,
    -  :too_many_write_operations => TooManyWriteOperationsError
    +  relocation_error: RelocationError,
    +  internal_error: InternalError,
    +  too_many_write_operations: TooManyWriteOperationsError
     }.freeze
    @@ -153,9 +153,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/RelocationError.html b/docs/DropboxApi/Errors/RelocationError.html index aa6f941a..e597cf93 100644 --- a/docs/DropboxApi/Errors/RelocationError.html +++ b/docs/DropboxApi/Errors/RelocationError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::RelocationError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,13 +116,13 @@

    {
    -  :from_lookup => LookupError,
    -  :from_write => WriteError,
    -  :to => WriteError,
    -  :cant_copy_shared_folder => CantCopySharedFolderError,
    -  :cant_nest_shared_folder => CantNestSharedFolderError,
    -  :cant_move_folder_into_itself => CantMoveFolderIntoItselfError,
    -  :too_many_files => TooManyFilesError
    +  from_lookup: LookupError,
    +  from_write: WriteError,
    +  to: WriteError,
    +  cant_copy_shared_folder: CantCopySharedFolderError,
    +  cant_nest_shared_folder: CantNestSharedFolderError,
    +  cant_move_folder_into_itself: CantMoveFolderIntoItselfError,
    +  too_many_files: TooManyFilesError
     }.freeze
    @@ -157,9 +157,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/RestoreError.html b/docs/DropboxApi/Errors/RestoreError.html index 7e6e0dfb..a84264bd 100644 --- a/docs/DropboxApi/Errors/RestoreError.html +++ b/docs/DropboxApi/Errors/RestoreError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::RestoreError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,9 +116,9 @@

    {
    -  :path_lookup => LookupError,
    -  :path_write => WriteError,
    -  :invalid_revision => InvalidRevisionError
    +  path_lookup: LookupError,
    +  path_write: WriteError,
    +  invalid_revision: InvalidRevisionError
     }.freeze
    @@ -153,9 +153,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/RestrictedContentError.html b/docs/DropboxApi/Errors/RestrictedContentError.html index dd8bcf55..e237b61d 100644 --- a/docs/DropboxApi/Errors/RestrictedContentError.html +++ b/docs/DropboxApi/Errors/RestrictedContentError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::RestrictedContentError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/RevokeSharedLinkError.html b/docs/DropboxApi/Errors/RevokeSharedLinkError.html index fb844d69..5b0246bc 100644 --- a/docs/DropboxApi/Errors/RevokeSharedLinkError.html +++ b/docs/DropboxApi/Errors/RevokeSharedLinkError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::RevokeSharedLinkError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,10 +116,10 @@

    {
    -  :shared_link_not_found => SharedLinkNotFoundError,
    -  :shared_link_access_denied => SharedLinkAccessDeniedError,
    -  :unsupported_link_type => UnsupportedLinkTypeError,
    -  :shared_link_malformed => SharedLinkMalformedError
    +  shared_link_not_found: SharedLinkNotFoundError,
    +  shared_link_access_denied: SharedLinkAccessDeniedError,
    +  unsupported_link_type: UnsupportedLinkTypeError,
    +  shared_link_malformed: SharedLinkMalformedError
     }.freeze
    @@ -154,9 +154,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SaveCopyReferenceError.html b/docs/DropboxApi/Errors/SaveCopyReferenceError.html index 9420b3a1..f047b597 100644 --- a/docs/DropboxApi/Errors/SaveCopyReferenceError.html +++ b/docs/DropboxApi/Errors/SaveCopyReferenceError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SaveCopyReferenceError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,11 +116,11 @@

    {
    -  :path => WriteError,
    -  :invalid_copy_reference => InvalidCopyReferenceError,
    -  :no_permission => NoPermissionError,
    -  :not_found => NotFoundError,
    -  :too_many_files => TooManyFilesError
    +  path: WriteError,
    +  invalid_copy_reference: InvalidCopyReferenceError,
    +  no_permission: NoPermissionError,
    +  not_found: NotFoundError,
    +  too_many_files: TooManyFilesError
     }.freeze
    @@ -155,9 +155,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SaveUrlError.html b/docs/DropboxApi/Errors/SaveUrlError.html index e20842f8..341b950d 100644 --- a/docs/DropboxApi/Errors/SaveUrlError.html +++ b/docs/DropboxApi/Errors/SaveUrlError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SaveUrlError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,10 +116,10 @@

    {
    -  :path => WriteError,
    -  :download_failed => DownloadFailedError,
    -  :invalid_url => InvalidUrlError,
    -  :not_found => NotFoundError
    +  path: WriteError,
    +  download_failed: DownloadFailedError,
    +  invalid_url: InvalidUrlError,
    +  not_found: NotFoundError
     }.freeze
    @@ -154,9 +154,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SearchError.html b/docs/DropboxApi/Errors/SearchError.html index 2d357343..58abe463 100644 --- a/docs/DropboxApi/Errors/SearchError.html +++ b/docs/DropboxApi/Errors/SearchError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SearchError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :path => LookupError
    +  path: LookupError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SettingsError.html b/docs/DropboxApi/Errors/SettingsError.html index 98db4a90..15b6cfde 100644 --- a/docs/DropboxApi/Errors/SettingsError.html +++ b/docs/DropboxApi/Errors/SettingsError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SettingsError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,8 +116,8 @@

    {
    -  :invalid_settings => InvalidSettingsError,
    -  :not_authorized => NoPermissionError
    +  invalid_settings: InvalidSettingsError,
    +  not_authorized: NoPermissionError
     }.freeze
    @@ -152,9 +152,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/ShareFolderError.html b/docs/DropboxApi/Errors/ShareFolderError.html index 1d9bcc46..a89f6f69 100644 --- a/docs/DropboxApi/Errors/ShareFolderError.html +++ b/docs/DropboxApi/Errors/ShareFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::ShareFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,11 +116,11 @@

    {
    -  :email_unverified => EmailUnverifiedError,
    -  :bad_path => SharePathError,
    -  :team_policy_disallows_member_policy => TeamPolicyDisallowsMemberPolicyError,
    -  :disallowed_shared_link_policy => DisallowedSharedLinkPolicyError,
    -  :no_permission => NoPermissionError
    +  email_unverified: EmailUnverifiedError,
    +  bad_path: SharePathError,
    +  team_policy_disallows_member_policy: TeamPolicyDisallowsMemberPolicyError,
    +  disallowed_shared_link_policy: DisallowedSharedLinkPolicyError,
    +  no_permission: NoPermissionError
     }.freeze
    @@ -155,9 +155,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SharePathError.html b/docs/DropboxApi/Errors/SharePathError.html index aeadf431..1f369c0e 100644 --- a/docs/DropboxApi/Errors/SharePathError.html +++ b/docs/DropboxApi/Errors/SharePathError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SharePathError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,17 +116,17 @@

    {
    -  :is_file => IsFileError,
    -  :inside_shared_folder => InsideSharedFolderError,
    -  :contains_shared_folder => ContainsSharedFolderError,
    -  :is_app_folder => IsAppFolderError,
    -  :inside_app_folder => InsideAppFolderError,
    -  :is_public_folder => IsPublicFolderError,
    -  :inside_public_folder => InsidePublicFolderError,
    -  :already_shared => AlreadySharedError,
    -  :invalid_path => InvalidPathError,
    -  :is_osx_package => IsOsxPackageError,
    -  :inside_osx_package => InsideOsxPackageError,
    +  is_file: IsFileError,
    +  inside_shared_folder: InsideSharedFolderError,
    +  contains_shared_folder: ContainsSharedFolderError,
    +  is_app_folder: IsAppFolderError,
    +  inside_app_folder: InsideAppFolderError,
    +  is_public_folder: IsPublicFolderError,
    +  inside_public_folder: InsidePublicFolderError,
    +  already_shared: AlreadySharedError,
    +  invalid_path: InvalidPathError,
    +  is_osx_package: IsOsxPackageError,
    +  inside_osx_package: InsideOsxPackageError,
     }.freeze
    @@ -161,9 +161,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SharedFolderAccessError.html b/docs/DropboxApi/Errors/SharedFolderAccessError.html index 1e57fec7..81c1530c 100644 --- a/docs/DropboxApi/Errors/SharedFolderAccessError.html +++ b/docs/DropboxApi/Errors/SharedFolderAccessError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SharedFolderAccessError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,10 +116,10 @@

    {
    -  :invalid_id => InvalidIdError,
    -  :not_a_member => NotAMemberError,
    -  :email_unverified => EmailUnverifiedError,
    -  :unmounted => UnmountedError
    +  invalid_id: InvalidIdError,
    +  not_a_member: NotAMemberError,
    +  email_unverified: EmailUnverifiedError,
    +  unmounted: UnmountedError
     }.freeze
    @@ -154,9 +154,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SharedLinkAccessDeniedError.html b/docs/DropboxApi/Errors/SharedLinkAccessDeniedError.html index f43e14aa..ede8690b 100644 --- a/docs/DropboxApi/Errors/SharedLinkAccessDeniedError.html +++ b/docs/DropboxApi/Errors/SharedLinkAccessDeniedError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SharedLinkAccessDeniedError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError.html b/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError.html index 75e54bf5..0a329553 100644 --- a/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError.html +++ b/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SharedLinkAlreadyExistsError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SharedLinkError.html b/docs/DropboxApi/Errors/SharedLinkError.html index 8ea4a1b2..4f767093 100644 --- a/docs/DropboxApi/Errors/SharedLinkError.html +++ b/docs/DropboxApi/Errors/SharedLinkError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SharedLinkError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,9 +116,9 @@

    {
    -  :shared_link_not_found => SharedLinkNotFoundError,
    -  :shared_link_access_denied => SharedLinkAccessDeniedError,
    -  :unsupported_link_type => UnsupportedLinkTypeError
    +  shared_link_not_found: SharedLinkNotFoundError,
    +  shared_link_access_denied: SharedLinkAccessDeniedError,
    +  unsupported_link_type: UnsupportedLinkTypeError
     }.freeze
    @@ -153,9 +153,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SharedLinkMalformedError.html b/docs/DropboxApi/Errors/SharedLinkMalformedError.html index 2417f8fa..a0b3d8de 100644 --- a/docs/DropboxApi/Errors/SharedLinkMalformedError.html +++ b/docs/DropboxApi/Errors/SharedLinkMalformedError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SharedLinkMalformedError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SharedLinkNotFoundError.html b/docs/DropboxApi/Errors/SharedLinkNotFoundError.html index 59dc675e..a75496a2 100644 --- a/docs/DropboxApi/Errors/SharedLinkNotFoundError.html +++ b/docs/DropboxApi/Errors/SharedLinkNotFoundError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SharedLinkNotFoundError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SharingFileAccessError.html b/docs/DropboxApi/Errors/SharingFileAccessError.html index 3f4e6a1b..f48dffb0 100644 --- a/docs/DropboxApi/Errors/SharingFileAccessError.html +++ b/docs/DropboxApi/Errors/SharingFileAccessError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SharingFileAccessError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,11 +116,11 @@

    {
    -  :no_permission => NoPermissionError,
    -  :invalid_file => InvalidFileError,
    -  :is_folder => IsFolderError,
    -  :inside_public_folder => InsidePublicFolderError,
    -  :inside_osx_package => InsideOsxPackageError
    +  no_permission: NoPermissionError,
    +  invalid_file: InvalidFileError,
    +  is_folder: IsFolderError,
    +  inside_public_folder: InsidePublicFolderError,
    +  inside_osx_package: InsideOsxPackageError
     }.freeze
    @@ -155,9 +155,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/SharingUserError.html b/docs/DropboxApi/Errors/SharingUserError.html index 1ccbf67d..5e2bfbac 100644 --- a/docs/DropboxApi/Errors/SharingUserError.html +++ b/docs/DropboxApi/Errors/SharingUserError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::SharingUserError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :email_unverified => EmailUnverifiedError
    +  email_unverified: EmailUnverifiedError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/TeamFolderError.html b/docs/DropboxApi/Errors/TeamFolderError.html index 32b148c6..7dc76ece 100644 --- a/docs/DropboxApi/Errors/TeamFolderError.html +++ b/docs/DropboxApi/Errors/TeamFolderError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::TeamFolderError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html b/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html index 0b1a506f..f3239b73 100644 --- a/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html +++ b/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::TeamPolicyDisallowsMemberPolicyError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/ThumbnailBatchError.html b/docs/DropboxApi/Errors/ThumbnailBatchError.html index 755685cd..d6231c7e 100644 --- a/docs/DropboxApi/Errors/ThumbnailBatchError.html +++ b/docs/DropboxApi/Errors/ThumbnailBatchError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::ThumbnailBatchError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :too_many_files => TooManyFilesError
    +  too_many_files: TooManyFilesError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/ThumbnailError.html b/docs/DropboxApi/Errors/ThumbnailError.html index c4c3f922..6e600caf 100644 --- a/docs/DropboxApi/Errors/ThumbnailError.html +++ b/docs/DropboxApi/Errors/ThumbnailError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::ThumbnailError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,10 +116,10 @@

    {
    -  :path => LookupError,
    -  :unsupported_extension => UnsupportedExtensionError,
    -  :unsupported_image => UnsupportedImageError,
    -  :conversion_error => ConversionError
    +  path: LookupError,
    +  unsupported_extension: UnsupportedExtensionError,
    +  unsupported_image: UnsupportedImageError,
    +  conversion_error: ConversionError
     }.freeze
    @@ -154,9 +154,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/TooManyFilesError.html b/docs/DropboxApi/Errors/TooManyFilesError.html index 749ef05e..d01f739b 100644 --- a/docs/DropboxApi/Errors/TooManyFilesError.html +++ b/docs/DropboxApi/Errors/TooManyFilesError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::TooManyFilesError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/TooManyMembersError.html b/docs/DropboxApi/Errors/TooManyMembersError.html index 33b1d274..8161e7c9 100644 --- a/docs/DropboxApi/Errors/TooManyMembersError.html +++ b/docs/DropboxApi/Errors/TooManyMembersError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::TooManyMembersError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/TooManyPendingInvitesError.html b/docs/DropboxApi/Errors/TooManyPendingInvitesError.html index 7c9712ca..4e6bdd0e 100644 --- a/docs/DropboxApi/Errors/TooManyPendingInvitesError.html +++ b/docs/DropboxApi/Errors/TooManyPendingInvitesError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::TooManyPendingInvitesError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/TooManyRequestsError.html b/docs/DropboxApi/Errors/TooManyRequestsError.html index 3619e72e..a722e71b 100644 --- a/docs/DropboxApi/Errors/TooManyRequestsError.html +++ b/docs/DropboxApi/Errors/TooManyRequestsError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::TooManyRequestsError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -122,8 +122,8 @@

    {
    -  :too_many_requests => TooManyRequestsError,
    -  :too_many_write_operations => TooManyWriteOperationsError
    +  too_many_requests: TooManyRequestsError,
    +  too_many_write_operations: TooManyWriteOperationsError
     }
    @@ -234,7 +234,7 @@

    -

    Returns the value of attribute retry_after

    +

    Returns the value of attribute retry_after.

    @@ -249,12 +249,12 @@

     
     
    -6
     7
    -8
    +8 +9

    -
    # File 'lib/dropbox_api/errors/too_many_requests_error.rb', line 6
    +      
    # File 'lib/dropbox_api/errors/too_many_requests_error.rb', line 7
     
     def retry_after
       @retry_after
    @@ -287,14 +287,14 @@ 

     
     
    -8
     9
     10
     11
    -12
    +12 +13

    -
    # File 'lib/dropbox_api/errors/too_many_requests_error.rb', line 8
    +      
    # File 'lib/dropbox_api/errors/too_many_requests_error.rb', line 9
     
     def self.build(message, )
       subtype,  = find_subtype 
    @@ -311,9 +311,9 @@ 

    diff --git a/docs/DropboxApi/Errors/TooManySharedFolderTargetsError.html b/docs/DropboxApi/Errors/TooManySharedFolderTargetsError.html index ffc8e17b..88058ece 100644 --- a/docs/DropboxApi/Errors/TooManySharedFolderTargetsError.html +++ b/docs/DropboxApi/Errors/TooManySharedFolderTargetsError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::TooManySharedFolderTargetsError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/TooManyWriteOperationsError.html b/docs/DropboxApi/Errors/TooManyWriteOperationsError.html index ce29437a..5a6a8bbb 100644 --- a/docs/DropboxApi/Errors/TooManyWriteOperationsError.html +++ b/docs/DropboxApi/Errors/TooManyWriteOperationsError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::TooManyWriteOperationsError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -157,9 +157,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/UnmountedError.html b/docs/DropboxApi/Errors/UnmountedError.html index f70c0e63..4b0175dc 100644 --- a/docs/DropboxApi/Errors/UnmountedError.html +++ b/docs/DropboxApi/Errors/UnmountedError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::UnmountedError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/UnshareFileError.html b/docs/DropboxApi/Errors/UnshareFileError.html index 0f64302b..7a291b59 100644 --- a/docs/DropboxApi/Errors/UnshareFileError.html +++ b/docs/DropboxApi/Errors/UnshareFileError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::UnshareFileError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,8 +116,8 @@

    {
    -  :user_error => SharingUserError,
    -  :access_error => SharingFileAccessError
    +  user_error: SharingUserError,
    +  access_error: SharingFileAccessError
     }.freeze
    @@ -152,9 +152,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/UnsupportedContentError.html b/docs/DropboxApi/Errors/UnsupportedContentError.html index c593bccd..1c8e50c8 100644 --- a/docs/DropboxApi/Errors/UnsupportedContentError.html +++ b/docs/DropboxApi/Errors/UnsupportedContentError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::UnsupportedContentError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/UnsupportedExtensionError.html b/docs/DropboxApi/Errors/UnsupportedExtensionError.html index 610189d0..b50bbadf 100644 --- a/docs/DropboxApi/Errors/UnsupportedExtensionError.html +++ b/docs/DropboxApi/Errors/UnsupportedExtensionError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::UnsupportedExtensionError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/UnsupportedImageError.html b/docs/DropboxApi/Errors/UnsupportedImageError.html index 30c71bfb..52d07276 100644 --- a/docs/DropboxApi/Errors/UnsupportedImageError.html +++ b/docs/DropboxApi/Errors/UnsupportedImageError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::UnsupportedImageError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/UnsupportedLinkTypeError.html b/docs/DropboxApi/Errors/UnsupportedLinkTypeError.html index 877f5db9..03e29bec 100644 --- a/docs/DropboxApi/Errors/UnsupportedLinkTypeError.html +++ b/docs/DropboxApi/Errors/UnsupportedLinkTypeError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::UnsupportedLinkTypeError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/UnverifiedDropboxId.html b/docs/DropboxApi/Errors/UnverifiedDropboxId.html index 2b91d399..d3e847b7 100644 --- a/docs/DropboxApi/Errors/UnverifiedDropboxId.html +++ b/docs/DropboxApi/Errors/UnverifiedDropboxId.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::UnverifiedDropboxId - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -133,9 +133,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/UploadError.html b/docs/DropboxApi/Errors/UploadError.html index fb384dbb..5f8263ea 100644 --- a/docs/DropboxApi/Errors/UploadError.html +++ b/docs/DropboxApi/Errors/UploadError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::UploadError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :path => UploadWriteFailedError
    +  path: UploadWriteFailedError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/UploadSessionFinishError.html b/docs/DropboxApi/Errors/UploadSessionFinishError.html index 0fbd4a3a..5a76dde0 100644 --- a/docs/DropboxApi/Errors/UploadSessionFinishError.html +++ b/docs/DropboxApi/Errors/UploadSessionFinishError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::UploadSessionFinishError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,9 +116,9 @@

    {
    -  :lookup_failed => UploadSessionLookupError,
    -  :path => WriteError,
    -  :too_many_shared_folder_targets => TooManySharedFolderTargetsError
    +  lookup_failed: UploadSessionLookupError,
    +  path: WriteError,
    +  too_many_shared_folder_targets: TooManySharedFolderTargetsError
     }.freeze
    @@ -153,9 +153,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/UploadSessionLookupError.html b/docs/DropboxApi/Errors/UploadSessionLookupError.html index 1cfe2ec4..ce2a8d98 100644 --- a/docs/DropboxApi/Errors/UploadSessionLookupError.html +++ b/docs/DropboxApi/Errors/UploadSessionLookupError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::UploadSessionLookupError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,10 +116,10 @@

    {
    -  :not_found => NotFoundError,
    -  :incorrect_offset => UploadSessionOffsetError,
    -  :closed => CursorClosedError,
    -  :not_closed => CursorNotClosedError
    +  not_found: NotFoundError,
    +  incorrect_offset: UploadSessionOffsetError,
    +  closed: CursorClosedError,
    +  not_closed: CursorNotClosedError
     }.freeze
    @@ -154,9 +154,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/UploadSessionOffsetError.html b/docs/DropboxApi/Errors/UploadSessionOffsetError.html index 2a3e678a..e8ecf3d3 100644 --- a/docs/DropboxApi/Errors/UploadSessionOffsetError.html +++ b/docs/DropboxApi/Errors/UploadSessionOffsetError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::UploadSessionOffsetError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -172,7 +172,7 @@

    -

    Returns a new instance of UploadSessionOffsetError

    +

    Returns a new instance of UploadSessionOffsetError.

    @@ -187,13 +187,13 @@

     
     
    -3
     4
     5
    -6
    +6 +7

    -
    # File 'lib/dropbox_api/errors/upload_session_offset_error.rb', line 3
    +      
    # File 'lib/dropbox_api/errors/upload_session_offset_error.rb', line 4
     
     def initialize(message, )
       message = "#{message}, correct offset: #{['correct_offset']}"
    @@ -210,9 +210,9 @@ 

    diff --git a/docs/DropboxApi/Errors/UploadWriteFailedError.html b/docs/DropboxApi/Errors/UploadWriteFailedError.html index 8ac8cbfe..7d83bb62 100644 --- a/docs/DropboxApi/Errors/UploadWriteFailedError.html +++ b/docs/DropboxApi/Errors/UploadWriteFailedError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::UploadWriteFailedError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,7 +116,7 @@

    {
    -  :reason => WriteError
    +  reason: WriteError
     }.freeze
    @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/WriteConflictError.html b/docs/DropboxApi/Errors/WriteConflictError.html index b4f9df43..4703bb19 100644 --- a/docs/DropboxApi/Errors/WriteConflictError.html +++ b/docs/DropboxApi/Errors/WriteConflictError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::WriteConflictError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,9 +116,9 @@

    {
    -  :file => FileConflictError,
    -  :folder => FolderConflictError,
    -  :file_ancestor => FileAncestorConflictError
    +  file: FileConflictError,
    +  folder: FolderConflictError,
    +  file_ancestor: FileAncestorConflictError
     }
    @@ -153,9 +153,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Errors/WriteError.html b/docs/DropboxApi/Errors/WriteError.html index 88d0d256..3568712c 100644 --- a/docs/DropboxApi/Errors/WriteError.html +++ b/docs/DropboxApi/Errors/WriteError.html @@ -6,15 +6,15 @@ Exception: DropboxApi::Errors::WriteError - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -116,11 +116,11 @@

    {
    -  :malformed_path => MalformedPathError,
    -  :conflict => WriteConflictError,
    -  :no_write_permission => NoWritePermissionError,
    -  :insufficient_space => InsufficientSpaceError,
    -  :disallowed_name => DisallowedNameError
    +  malformed_path: MalformedPathError,
    +  conflict: WriteConflictError,
    +  no_write_permission: NoWritePermissionError,
    +  insufficient_space: InsufficientSpaceError,
    +  disallowed_name: DisallowedNameError
     }
    @@ -155,9 +155,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata.html b/docs/DropboxApi/Metadata.html index 2a34cd18..983dda07 100644 --- a/docs/DropboxApi/Metadata.html +++ b/docs/DropboxApi/Metadata.html @@ -6,15 +6,15 @@ Module: DropboxApi::Metadata - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -79,7 +79,7 @@
    Defined in:
    lib/dropbox_api/metadata/tag.rb,
    - lib/dropbox_api/metadata/base.rb,
    lib/dropbox_api/metadata/file.rb,
    lib/dropbox_api/metadata/name.rb,
    lib/dropbox_api/metadata/team.rb,
    lib/dropbox_api/metadata/field.rb,
    lib/dropbox_api/metadata/folder.rb,
    lib/dropbox_api/metadata/member.rb,
    lib/dropbox_api/metadata/deleted.rb,
    lib/dropbox_api/metadata/location.rb,
    lib/dropbox_api/metadata/resource.rb,
    lib/dropbox_api/metadata/add_member.rb,
    lib/dropbox_api/metadata/dimensions.rb,
    lib/dropbox_api/metadata/media_info.rb,
    lib/dropbox_api/metadata/write_mode.rb,
    lib/dropbox_api/metadata/commit_info.rb,
    lib/dropbox_api/metadata/shared_link.rb,
    lib/dropbox_api/metadata/space_usage.rb,
    lib/dropbox_api/metadata/access_level.rb,
    lib/dropbox_api/metadata/file_request.rb,
    lib/dropbox_api/metadata/basic_account.rb,
    lib/dropbox_api/metadata/member_action.rb,
    lib/dropbox_api/metadata/shared_folder.rb,
    lib/dropbox_api/metadata/media_metadata.rb,
    lib/dropbox_api/metadata/photo_metadata.rb,
    lib/dropbox_api/metadata/video_metadata.rb,
    lib/dropbox_api/metadata/link_permissions.rb,
    lib/dropbox_api/metadata/space_allocation.rb,
    lib/dropbox_api/metadata/team_member_info.rb,
    lib/dropbox_api/metadata/member_permission.rb,
    lib/dropbox_api/metadata/file_link_metadata.rb,
    lib/dropbox_api/metadata/file_member_action.rb,
    lib/dropbox_api/metadata/member_action_list.rb,
    lib/dropbox_api/metadata/folder_sharing_info.rb,
    lib/dropbox_api/metadata/folder_link_metadata.rb,
    lib/dropbox_api/metadata/shared_folder_policy.rb,
    lib/dropbox_api/metadata/shared_link_metadata.rb,
    lib/dropbox_api/metadata/upload_session_cursor.rb,
    lib/dropbox_api/metadata/add_file_member_result.rb,
    lib/dropbox_api/metadata/member_permission_list.rb,
    lib/dropbox_api/metadata/parent_folder_access_info.rb,
    lib/dropbox_api/metadata/thumbnail_batch_result_data.rb,
    lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb
    + lib/dropbox_api/metadata/base.rb,
    lib/dropbox_api/metadata/file.rb,
    lib/dropbox_api/metadata/name.rb,
    lib/dropbox_api/metadata/team.rb,
    lib/dropbox_api/metadata/field.rb,
    lib/dropbox_api/metadata/folder.rb,
    lib/dropbox_api/metadata/member.rb,
    lib/dropbox_api/metadata/deleted.rb,
    lib/dropbox_api/metadata/location.rb,
    lib/dropbox_api/metadata/resource.rb,
    lib/dropbox_api/metadata/root_info.rb,
    lib/dropbox_api/metadata/add_member.rb,
    lib/dropbox_api/metadata/dimensions.rb,
    lib/dropbox_api/metadata/media_info.rb,
    lib/dropbox_api/metadata/write_mode.rb,
    lib/dropbox_api/metadata/commit_info.rb,
    lib/dropbox_api/metadata/file_status.rb,
    lib/dropbox_api/metadata/metadata_v2.rb,
    lib/dropbox_api/metadata/shared_link.rb,
    lib/dropbox_api/metadata/space_usage.rb,
    lib/dropbox_api/metadata/access_level.rb,
    lib/dropbox_api/metadata/file_request.rb,
    lib/dropbox_api/metadata/namespace_id.rb,
    lib/dropbox_api/metadata/basic_account.rb,
    lib/dropbox_api/metadata/file_category.rb,
    lib/dropbox_api/metadata/member_action.rb,
    lib/dropbox_api/metadata/shared_folder.rb,
    lib/dropbox_api/metadata/media_metadata.rb,
    lib/dropbox_api/metadata/photo_metadata.rb,
    lib/dropbox_api/metadata/search_options.rb,
    lib/dropbox_api/metadata/team_root_info.rb,
    lib/dropbox_api/metadata/user_root_info.rb,
    lib/dropbox_api/metadata/video_metadata.rb,
    lib/dropbox_api/metadata/search_match_v2.rb,
    lib/dropbox_api/metadata/search_order_by.rb,
    lib/dropbox_api/metadata/link_permissions.rb,
    lib/dropbox_api/metadata/space_allocation.rb,
    lib/dropbox_api/metadata/team_member_info.rb,
    lib/dropbox_api/metadata/member_permission.rb,
    lib/dropbox_api/metadata/file_link_metadata.rb,
    lib/dropbox_api/metadata/file_member_action.rb,
    lib/dropbox_api/metadata/member_action_list.rb,
    lib/dropbox_api/metadata/folder_sharing_info.rb,
    lib/dropbox_api/metadata/file_categories_list.rb,
    lib/dropbox_api/metadata/file_extensions_list.rb,
    lib/dropbox_api/metadata/folder_link_metadata.rb,
    lib/dropbox_api/metadata/search_match_type_v2.rb,
    lib/dropbox_api/metadata/shared_folder_policy.rb,
    lib/dropbox_api/metadata/shared_link_metadata.rb,
    lib/dropbox_api/metadata/upload_session_cursor.rb,
    lib/dropbox_api/metadata/add_file_member_result.rb,
    lib/dropbox_api/metadata/member_permission_list.rb,
    lib/dropbox_api/metadata/parent_folder_access_info.rb,
    lib/dropbox_api/metadata/search_match_field_options.rb,
    lib/dropbox_api/metadata/thumbnail_batch_result_data.rb,
    lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb
    @@ -91,7 +91,7 @@

    Defined Under Namespace

    - Classes: AccessLevel, AddFileMemberResult, AddMember, Base, BasicAccount, CommitInfo, Deleted, Dimensions, Field, File, FileLinkMetadata, FileMemberAction, FileRequest, Folder, FolderLinkMetadata, FolderSharingInfo, LinkPermissions, Location, MediaInfo, MediaMetadata, Member, MemberAction, MemberActionList, MemberPermission, MemberPermissionList, Name, ParentFolderAccessInfo, PhotoMetadata, Resource, SharedFolder, SharedFolderPolicy, SharedLink, SharedLinkMetadata, SpaceAllocation, SpaceUsage, Tag, Team, TeamMemberInfo, ThumbnailBatchResultData, ThumbnailBatchResultEntry, UploadSessionCursor, VideoMetadata, WriteMode + Classes: AccessLevel, AddFileMemberResult, AddMember, Base, BasicAccount, CommitInfo, Deleted, Dimensions, Field, File, FileCategoriesList, FileCategory, FileExtensionsList, FileLinkMetadata, FileMemberAction, FileRequest, FileStatus, Folder, FolderLinkMetadata, FolderSharingInfo, LinkPermissions, Location, MediaInfo, MediaMetadata, Member, MemberAction, MemberActionList, MemberPermission, MemberPermissionList, MetadataV2, Name, NamespaceId, ParentFolderAccessInfo, PhotoMetadata, Resource, RootInfo, SearchMatchFieldOptions, SearchMatchTypeV2, SearchMatchV2, SearchOptions, SearchOrderBy, SharedFolder, SharedFolderPolicy, SharedLink, SharedLinkMetadata, SpaceAllocation, SpaceUsage, Tag, Team, TeamMemberInfo, TeamRootInfo, ThumbnailBatchResultData, ThumbnailBatchResultEntry, UploadSessionCursor, UserRootInfo, VideoMetadata, WriteMode

    @@ -107,9 +107,9 @@

    Defined Under Namespace

    diff --git a/docs/DropboxApi/Metadata/AccessLevel.html b/docs/DropboxApi/Metadata/AccessLevel.html index 875fbc0e..f053915a 100644 --- a/docs/DropboxApi/Metadata/AccessLevel.html +++ b/docs/DropboxApi/Metadata/AccessLevel.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::AccessLevel - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -229,12 +229,12 @@

     
     
    -17
     18
    -19
    +19 +20

    -
    # File 'lib/dropbox_api/metadata/access_level.rb', line 17
    +      
    # File 'lib/dropbox_api/metadata/access_level.rb', line 18
     
     def self.valid_values
       VALID_ACCESS_LEVELS
    @@ -249,9 +249,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/AddFileMemberResult.html b/docs/DropboxApi/Metadata/AddFileMemberResult.html index 5f724df0..dec32027 100644 --- a/docs/DropboxApi/Metadata/AddFileMemberResult.html +++ b/docs/DropboxApi/Metadata/AddFileMemberResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::AddFileMemberResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -154,9 +154,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/AddMember.html b/docs/DropboxApi/Metadata/AddMember.html index f70fc8fc..b6b92cfe 100644 --- a/docs/DropboxApi/Metadata/AddMember.html +++ b/docs/DropboxApi/Metadata/AddMember.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::AddMember - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -210,20 +210,20 @@

     
     
    -26
     27
     28
     29
     30
    -31
    +31 +32

    -
    # File 'lib/dropbox_api/metadata/add_member.rb', line 26
    +      
    # File 'lib/dropbox_api/metadata/add_member.rb', line 27
     
     def build_from_string(member, access_level = :editor)
       new({
    -    "member" => Member.new(member),
    -    "access_level" => access_level
    +    'member' => Member.new(member),
    +    'access_level' => access_level
       })
     end
    @@ -236,9 +236,9 @@

    diff --git a/docs/DropboxApi/Metadata/Base.html b/docs/DropboxApi/Metadata/Base.html index 4a39b472..a07f9693 100644 --- a/docs/DropboxApi/Metadata/Base.html +++ b/docs/DropboxApi/Metadata/Base.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::Base - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -101,7 +101,7 @@ @@ -331,14 +331,14 @@

     
     
    -33
     34
     35
     36
    -37
    +37 +38

    -
    # File 'lib/dropbox_api/metadata/base.rb', line 33
    +      
    # File 'lib/dropbox_api/metadata/base.rb', line 34
     
     def initialize()
       self.class.fields.keys.each do |field_name|
    @@ -368,7 +368,7 @@ 

    -

    Returns the value of attribute fields

    +

    Returns the value of attribute fields.

    @@ -383,12 +383,12 @@

     
     
    -4
     5
    -6
    +6 +7

    -
    # File 'lib/dropbox_api/metadata/base.rb', line 4
    +      
    # File 'lib/dropbox_api/metadata/base.rb', line 5
     
     def fields
       @fields
    @@ -421,15 +421,15 @@ 

     
     
    -6
     7
     8
     9
     10
    -11
    +11 +12

    -
    # File 'lib/dropbox_api/metadata/base.rb', line 6
    +      
    # File 'lib/dropbox_api/metadata/base.rb', line 7
     
     def field(name, type, *options)
       @fields ||= {}
    @@ -464,7 +464,6 @@ 

     
     
    -45
     46
     47
     48
    @@ -474,16 +473,17 @@ 

    52 53 54 -55

    +55 +56

    -
    # File 'lib/dropbox_api/metadata/base.rb', line 45
    +      
    # File 'lib/dropbox_api/metadata/base.rb', line 46
     
     def serialized_field(field_name)
       value = send field_name
       case value
       when Time
    -    value.utc.strftime("%FT%TZ")
    +    value.utc.strftime('%FT%TZ')
       when DropboxApi::Metadata::Base
         value.to_hash
       else
    @@ -511,14 +511,14 @@ 

     
     
    -39
     40
     41
     42
    -43
    +43 +44

    -
    # File 'lib/dropbox_api/metadata/base.rb', line 39
    +      
    # File 'lib/dropbox_api/metadata/base.rb', line 40
     
     def to_hash
       Hash[self.class.fields.keys.map do |field_name|
    @@ -535,9 +535,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/BasicAccount.html b/docs/DropboxApi/Metadata/BasicAccount.html index 51f4faac..89e092fc 100644 --- a/docs/DropboxApi/Metadata/BasicAccount.html +++ b/docs/DropboxApi/Metadata/BasicAccount.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::BasicAccount - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -118,7 +118,12 @@

    Overview

    "disabled": false, "is_teammate": true, "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbid%3AAAH4f99T0taONIb-OurWxbNQ6ywGRopQngc?vers=1453416696524&size=128x128", - "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" + "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU", + "root_info": { + root_namespace_id: 7, + home_namespace_id: 1, + home_path: "/Franz Ferdinand" + } }
    @@ -157,9 +162,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/CommitInfo.html b/docs/DropboxApi/Metadata/CommitInfo.html index d89e358e..da2302e7 100644 --- a/docs/DropboxApi/Metadata/CommitInfo.html +++ b/docs/DropboxApi/Metadata/CommitInfo.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::CommitInfo - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -180,7 +180,6 @@

     
     
    -10
     11
     12
     13
    @@ -193,10 +192,11 @@ 

    20 21 22 -23

    +23 +24

    -
    # File 'lib/dropbox_api/metadata/commit_info.rb', line 10
    +      
    # File 'lib/dropbox_api/metadata/commit_info.rb', line 11
     
     def build_from_options(options)
       options = Hash[options.map do |key, value|
    @@ -222,9 +222,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/Deleted.html b/docs/DropboxApi/Metadata/Deleted.html index 896ae9f7..c7951338 100644 --- a/docs/DropboxApi/Metadata/Deleted.html +++ b/docs/DropboxApi/Metadata/Deleted.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::Deleted - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -148,9 +148,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/Dimensions.html b/docs/DropboxApi/Metadata/Dimensions.html index b528e5aa..f4a15ad6 100644 --- a/docs/DropboxApi/Metadata/Dimensions.html +++ b/docs/DropboxApi/Metadata/Dimensions.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::Dimensions - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -130,9 +130,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/Field.html b/docs/DropboxApi/Metadata/Field.html index 9d948eae..5cf05588 100644 --- a/docs/DropboxApi/Metadata/Field.html +++ b/docs/DropboxApi/Metadata/Field.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::Field - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -200,7 +200,7 @@

    -

    Returns a new instance of Field

    +

    Returns a new instance of Field.

    @@ -215,13 +215,13 @@

     
     
    -3
     4
     5
    -6
    +6 +7

    -
    # File 'lib/dropbox_api/metadata/field.rb', line 3
    +      
    # File 'lib/dropbox_api/metadata/field.rb', line 4
     
     def initialize(type, options = [])
       @type = type
    @@ -255,17 +255,17 @@ 

     
     
    -8
     9
     10
     11
     12
     13
     14
    -15
    +15 +16

    -
    # File 'lib/dropbox_api/metadata/field.rb', line 8
    +      
    # File 'lib/dropbox_api/metadata/field.rb', line 9
     
     def cast(object)
       if object.nil?
    @@ -296,7 +296,6 @@ 

     
     
    -17
     18
     19
     20
    @@ -314,10 +313,13 @@ 

    32 33 34 -35

    +35 +36 +37 +38

    -
    # File 'lib/dropbox_api/metadata/field.rb', line 17
    +      
    # File 'lib/dropbox_api/metadata/field.rb', line 18
     
     def force_cast(object)
       if @type == String
    @@ -329,13 +331,15 @@ 

    elsif @type == Float object.to_f elsif @type == Symbol - object[".tag"].to_sym + object['.tag'].to_sym elsif @type == :boolean - object.to_s == "true" - elsif @type.ancestors.include? DropboxApi::Metadata::Base + object.to_s == 'true' + elsif @type.ancestors.include?(DropboxApi::Metadata::Base) || + @type.ancestors.include?(Array) || + @type == DropboxApi::Metadata::Resource @type.new(object) else - raise NotImplementedError, "Can't cast `#{@type}`" + raise NotImplementedError, "Can't cast #{object} to `#{@type}`" end end

    @@ -348,9 +352,9 @@

    diff --git a/docs/DropboxApi/Metadata/File.html b/docs/DropboxApi/Metadata/File.html index f4e8bf07..bdc1dc42 100644 --- a/docs/DropboxApi/Metadata/File.html +++ b/docs/DropboxApi/Metadata/File.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::File - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -208,15 +208,15 @@

     
     
    -35
     36
    -37
    +37 +38

    -
    # File 'lib/dropbox_api/metadata/file.rb', line 35
    +      
    # File 'lib/dropbox_api/metadata/file.rb', line 36
     
     def to_hash
    -  super.merge(".tag" => "file")
    +  super.merge('.tag' => 'file')
     end
    @@ -228,9 +228,9 @@

    diff --git a/docs/DropboxApi/Metadata/FileCategoriesList.html b/docs/DropboxApi/Metadata/FileCategoriesList.html new file mode 100644 index 00000000..911ccb98 --- /dev/null +++ b/docs/DropboxApi/Metadata/FileCategoriesList.html @@ -0,0 +1,205 @@ + + + + + + + Class: DropboxApi::Metadata::FileCategoriesList + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::FileCategoriesList + + + +

    +
    + +
    +
    Inherits:
    +
    + Array + +
      +
    • Object
    • + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/file_categories_list.rb
    +
    + +
    + + + + + + + + + +

    + Instance Method Summary + collapse +

    + + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(list) ⇒ FileCategoriesList + + + + + +

    +
    +

    Returns a new instance of FileCategoriesList.

    + + +
    +
    +
    + + +
    + + + + + +
    +
    +
    +
    +5
    +6
    +7
    +
    +
    # File 'lib/dropbox_api/metadata/file_categories_list.rb', line 5
    +
    +def initialize(list)
    +  super(list.map { |c| DropboxApi::Metadata::FileCategory.new c })
    +end
    +
    +
    + +
    + + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/FileCategory.html b/docs/DropboxApi/Metadata/FileCategory.html new file mode 100644 index 00000000..ad2df2af --- /dev/null +++ b/docs/DropboxApi/Metadata/FileCategory.html @@ -0,0 +1,250 @@ + + + + + + + Class: DropboxApi::Metadata::FileCategory + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::FileCategory + + + +

    +
    + +
    +
    Inherits:
    +
    + Tag + +
      +
    • Object
    • + + + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/file_category.rb
    +
    + +
    + + + +

    + Constant Summary + collapse +

    + +
    + +
    VALID_VALUES = + +
    +
    %i[
    +  image
    +  document
    +  pdf
    +  spreadsheet
    +  presentation
    +  audio
    +  video
    +  folder
    +  paper
    +  others
    +].freeze
    + +
    + + + + + + + + + +

    + Class Method Summary + collapse +

    + + + + + + + + + + + + + +

    Methods inherited from Tag

    +

    new, validate

    + + + + + + + + + +

    Methods inherited from Base

    +

    field, #initialize, #serialized_field, #to_hash

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Metadata::Base

    + +
    + + +
    +

    Class Method Details

    + + +
    +

    + + .valid_valuesObject + + + + + +

    + + + + + +
    +
    +
    +
    +18
    +19
    +20
    +
    +
    # File 'lib/dropbox_api/metadata/file_category.rb', line 18
    +
    +def self.valid_values
    +  VALID_VALUES
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/FileExtensionsList.html b/docs/DropboxApi/Metadata/FileExtensionsList.html new file mode 100644 index 00000000..86a4b131 --- /dev/null +++ b/docs/DropboxApi/Metadata/FileExtensionsList.html @@ -0,0 +1,213 @@ + + + + + + + Class: DropboxApi::Metadata::FileExtensionsList + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::FileExtensionsList + + + +

    +
    + +
    +
    Inherits:
    +
    + Array + +
      +
    • Object
    • + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/file_extensions_list.rb
    +
    + +
    + + + + + + + + + +

    + Instance Method Summary + collapse +

    + + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(data) ⇒ FileExtensionsList + + + + + +

    +
    +

    Returns a new instance of FileExtensionsList.

    + + +
    +
    +
    + + +
    + + + + + +
    +
    +
    +
    +5
    +6
    +7
    +8
    +9
    +10
    +11
    +
    +
    # File 'lib/dropbox_api/metadata/file_extensions_list.rb', line 5
    +
    +def initialize(data)
    +  if !data.is_a?(Array) || data.any? { |v| !v.is_a? String }
    +    raise ArgumentError, "Invalid extension list: #{data.inspect}."
    +  end
    +
    +  super(data)
    +end
    +
    +
    + +
    + + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/FileLinkMetadata.html b/docs/DropboxApi/Metadata/FileLinkMetadata.html index bf45c04b..ec402322 100644 --- a/docs/DropboxApi/Metadata/FileLinkMetadata.html +++ b/docs/DropboxApi/Metadata/FileLinkMetadata.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::FileLinkMetadata - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -170,9 +170,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/FileMemberAction.html b/docs/DropboxApi/Metadata/FileMemberAction.html index e9778340..3b61d901 100644 --- a/docs/DropboxApi/Metadata/FileMemberAction.html +++ b/docs/DropboxApi/Metadata/FileMemberAction.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::FileMemberAction - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -198,16 +198,16 @@

     
     
    -14
     15
     16
    -17
    +17 +18

    -
    # File 'lib/dropbox_api/metadata/file_member_action.rb', line 14
    +      
    # File 'lib/dropbox_api/metadata/file_member_action.rb', line 15
     
     def new(data)
    -  tag = data[".tag"]
    +  tag = data['.tag']
       class_for(tag.to_sym).new(data[tag])
     end
    @@ -220,9 +220,9 @@

    diff --git a/docs/DropboxApi/Metadata/FileRequest.html b/docs/DropboxApi/Metadata/FileRequest.html index bce69e7f..60c51932 100644 --- a/docs/DropboxApi/Metadata/FileRequest.html +++ b/docs/DropboxApi/Metadata/FileRequest.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::FileRequest - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -157,9 +157,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/FileStatus.html b/docs/DropboxApi/Metadata/FileStatus.html new file mode 100644 index 00000000..43628440 --- /dev/null +++ b/docs/DropboxApi/Metadata/FileStatus.html @@ -0,0 +1,242 @@ + + + + + + + Class: DropboxApi::Metadata::FileStatus + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::FileStatus + + + +

    +
    + +
    +
    Inherits:
    +
    + Tag + +
      +
    • Object
    • + + + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/file_status.rb
    +
    + +
    + + + +

    + Constant Summary + collapse +

    + +
    + +
    VALID_VALUES = + +
    +
    %i[
    +  active
    +  deleted
    +].freeze
    + +
    + + + + + + + + + +

    + Class Method Summary + collapse +

    + + + + + + + + + + + + + +

    Methods inherited from Tag

    +

    new, validate

    + + + + + + + + + +

    Methods inherited from Base

    +

    field, #initialize, #serialized_field, #to_hash

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Metadata::Base

    + +
    + + +
    +

    Class Method Details

    + + +
    +

    + + .valid_valuesObject + + + + + +

    + + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/dropbox_api/metadata/file_status.rb', line 10
    +
    +def self.valid_values
    +  VALID_VALUES
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/Folder.html b/docs/DropboxApi/Metadata/Folder.html index 87802295..3e8bc809 100644 --- a/docs/DropboxApi/Metadata/Folder.html +++ b/docs/DropboxApi/Metadata/Folder.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::Folder - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -198,15 +198,15 @@

     
     
    -19
     20
    -21
    +21 +22

    -
    # File 'lib/dropbox_api/metadata/folder.rb', line 19
    +      
    # File 'lib/dropbox_api/metadata/folder.rb', line 20
     
     def to_hash
    -  super.merge(".tag" => "folder")
    +  super.merge('.tag' => 'folder')
     end
    @@ -218,9 +218,9 @@

    diff --git a/docs/DropboxApi/Metadata/FolderLinkMetadata.html b/docs/DropboxApi/Metadata/FolderLinkMetadata.html index b8d16f68..33bab527 100644 --- a/docs/DropboxApi/Metadata/FolderLinkMetadata.html +++ b/docs/DropboxApi/Metadata/FolderLinkMetadata.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::FolderLinkMetadata - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -130,9 +130,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/FolderSharingInfo.html b/docs/DropboxApi/Metadata/FolderSharingInfo.html index 8084bc4f..d7f70793 100644 --- a/docs/DropboxApi/Metadata/FolderSharingInfo.html +++ b/docs/DropboxApi/Metadata/FolderSharingInfo.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::FolderSharingInfo - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -146,9 +146,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/LinkPermissions.html b/docs/DropboxApi/Metadata/LinkPermissions.html index d40e3fb2..570c219f 100644 --- a/docs/DropboxApi/Metadata/LinkPermissions.html +++ b/docs/DropboxApi/Metadata/LinkPermissions.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::LinkPermissions - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -151,9 +151,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/Location.html b/docs/DropboxApi/Metadata/Location.html index 26af4669..0c0b3e53 100644 --- a/docs/DropboxApi/Metadata/Location.html +++ b/docs/DropboxApi/Metadata/Location.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::Location - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -130,9 +130,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/MediaInfo.html b/docs/DropboxApi/Metadata/MediaInfo.html index bd51b70e..be9cac4e 100644 --- a/docs/DropboxApi/Metadata/MediaInfo.html +++ b/docs/DropboxApi/Metadata/MediaInfo.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::MediaInfo - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -203,7 +203,6 @@

     
     
    -20
     21
     22
     23
    @@ -211,10 +210,11 @@ 

    25 26 27 -28

    +28 +29

    -
    # File 'lib/dropbox_api/metadata/media_info.rb', line 20
    +      
    # File 'lib/dropbox_api/metadata/media_info.rb', line 21
     
     def new(data)
       klass = class_for(data['.tag'].to_sym)
    @@ -235,9 +235,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/MediaMetadata.html b/docs/DropboxApi/Metadata/MediaMetadata.html index 4de35e14..69e74131 100644 --- a/docs/DropboxApi/Metadata/MediaMetadata.html +++ b/docs/DropboxApi/Metadata/MediaMetadata.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::MediaMetadata - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -205,13 +205,13 @@

     
     
    -21
     22
     23
    -24
    +24 +25

    -
    # File 'lib/dropbox_api/metadata/media_metadata.rb', line 21
    +      
    # File 'lib/dropbox_api/metadata/media_metadata.rb', line 22
     
     def new(data)
       tag = data['.tag']
    @@ -227,9 +227,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/Member.html b/docs/DropboxApi/Metadata/Member.html index 9a967717..e7e78b37 100644 --- a/docs/DropboxApi/Metadata/Member.html +++ b/docs/DropboxApi/Metadata/Member.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::Member - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -212,7 +212,7 @@

    -

    Returns a new instance of Member

    +

    Returns a new instance of Member.

    @@ -227,7 +227,6 @@

     
     
    -16
     17
     18
     19
    @@ -238,10 +237,11 @@ 

    24 25 26 -27

    +27 +28

    -
    # File 'lib/dropbox_api/metadata/member.rb', line 16
    +      
    # File 'lib/dropbox_api/metadata/member.rb', line 17
     
     def initialize(member)
       @member_hash = case member
    @@ -283,12 +283,12 @@ 

     
     
    -29
     30
    -31
    +31 +32

    -
    # File 'lib/dropbox_api/metadata/member.rb', line 29
    +      
    # File 'lib/dropbox_api/metadata/member.rb', line 30
     
     def to_hash
       @member_hash
    @@ -303,9 +303,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/MemberAction.html b/docs/DropboxApi/Metadata/MemberAction.html index 70f1a366..0757c391 100644 --- a/docs/DropboxApi/Metadata/MemberAction.html +++ b/docs/DropboxApi/Metadata/MemberAction.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::MemberAction - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -244,12 +244,12 @@

     
     
    -30
     31
    -32
    +32 +33

    -
    # File 'lib/dropbox_api/metadata/member_action.rb', line 30
    +      
    # File 'lib/dropbox_api/metadata/member_action.rb', line 31
     
     def self.valid_values
       VALID_MEMBER_ACTIONS
    @@ -264,9 +264,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/MemberActionList.html b/docs/DropboxApi/Metadata/MemberActionList.html index 502ba6d2..d7947db2 100644 --- a/docs/DropboxApi/Metadata/MemberActionList.html +++ b/docs/DropboxApi/Metadata/MemberActionList.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::MemberActionList - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -190,12 +190,12 @@

     
     
    -9
     10
    -11
    +11 +12

    -
    # File 'lib/dropbox_api/metadata/member_action_list.rb', line 9
    +      
    # File 'lib/dropbox_api/metadata/member_action_list.rb', line 10
     
     def initialize(list)
       super(list.map { |a| DropboxApi::Metadata::MemberAction.new a })
    @@ -211,9 +211,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/MemberPermission.html b/docs/DropboxApi/Metadata/MemberPermission.html index 0a19621d..a83d48da 100644 --- a/docs/DropboxApi/Metadata/MemberPermission.html +++ b/docs/DropboxApi/Metadata/MemberPermission.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::MemberPermission - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -153,9 +153,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/MemberPermissionList.html b/docs/DropboxApi/Metadata/MemberPermissionList.html index 902d6425..e9621802 100644 --- a/docs/DropboxApi/Metadata/MemberPermissionList.html +++ b/docs/DropboxApi/Metadata/MemberPermissionList.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::MemberPermissionList - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -191,7 +191,7 @@

    -

    Returns a new instance of MemberPermissionList

    +

    Returns a new instance of MemberPermissionList.

    @@ -206,12 +206,12 @@

     
     
    -26
     27
    -28
    +28 +29

    -
    # File 'lib/dropbox_api/metadata/member_permission_list.rb', line 26
    +      
    # File 'lib/dropbox_api/metadata/member_permission_list.rb', line 27
     
     def initialize(list)
       super(list.map { |i| DropboxApi::Metadata::MemberPermission.new i })
    @@ -227,9 +227,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/MetadataV2.html b/docs/DropboxApi/Metadata/MetadataV2.html new file mode 100644 index 00000000..ae6306fc --- /dev/null +++ b/docs/DropboxApi/Metadata/MetadataV2.html @@ -0,0 +1,140 @@ + + + + + + + Class: DropboxApi::Metadata::MetadataV2 + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::MetadataV2 + + + +

    +
    + +
    +
    Inherits:
    +
    + Base + +
      +
    • Object
    • + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/metadata_v2.rb
    +
    + +
    + + + + + + + + + + + + + + + +

    Method Summary

    + +

    Methods inherited from Base

    +

    field, #initialize, #serialized_field, #to_hash

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Metadata::Base

    + +
    + + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/Name.html b/docs/DropboxApi/Metadata/Name.html index c6909348..56bfc582 100644 --- a/docs/DropboxApi/Metadata/Name.html +++ b/docs/DropboxApi/Metadata/Name.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::Name - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -148,9 +148,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/NamespaceId.html b/docs/DropboxApi/Metadata/NamespaceId.html new file mode 100644 index 00000000..63d818b5 --- /dev/null +++ b/docs/DropboxApi/Metadata/NamespaceId.html @@ -0,0 +1,210 @@ + + + + + + + Class: DropboxApi::Metadata::NamespaceId + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::NamespaceId + + + +

    +
    + +
    +
    Inherits:
    +
    + Base + +
      +
    • Object
    • + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/namespace_id.rb
    +
    + +
    + + + + + + + + + +

    + Instance Method Summary + collapse +

    + + + + + + + + + + + + + +

    Methods inherited from Base

    +

    field, #initialize, #serialized_field

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Metadata::Base

    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #to_hashObject + + + + + +

    + + + + + +
    +
    +
    +
    +6
    +7
    +8
    +
    +
    # File 'lib/dropbox_api/metadata/namespace_id.rb', line 6
    +
    +def to_hash
    +  super.merge({".tag": 'namespace_id'})
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/ParentFolderAccessInfo.html b/docs/DropboxApi/Metadata/ParentFolderAccessInfo.html index e0f29040..f530fe30 100644 --- a/docs/DropboxApi/Metadata/ParentFolderAccessInfo.html +++ b/docs/DropboxApi/Metadata/ParentFolderAccessInfo.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::ParentFolderAccessInfo - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -130,9 +130,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/PhotoMetadata.html b/docs/DropboxApi/Metadata/PhotoMetadata.html index 2011974d..45e5e760 100644 --- a/docs/DropboxApi/Metadata/PhotoMetadata.html +++ b/docs/DropboxApi/Metadata/PhotoMetadata.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::PhotoMetadata - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -154,9 +154,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/Resource.html b/docs/DropboxApi/Metadata/Resource.html index 677c5ba7..9a29e504 100644 --- a/docs/DropboxApi/Metadata/Resource.html +++ b/docs/DropboxApi/Metadata/Resource.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::Resource - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -177,15 +177,15 @@

     
     
    -11
     12
    -13
    +13 +14

    -
    # File 'lib/dropbox_api/metadata/resource.rb', line 11
    +      
    # File 'lib/dropbox_api/metadata/resource.rb', line 12
     
     def new(data)
    -  class_for(data[".tag"].to_sym).new(data)
    +  class_for(data['.tag'].to_sym).new(data)
     end
    @@ -197,9 +197,9 @@

    diff --git a/docs/DropboxApi/Metadata/RootInfo.html b/docs/DropboxApi/Metadata/RootInfo.html new file mode 100644 index 00000000..887cda6a --- /dev/null +++ b/docs/DropboxApi/Metadata/RootInfo.html @@ -0,0 +1,227 @@ + + + + + + + Class: DropboxApi::Metadata::RootInfo + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::RootInfo + + + +

    +
    + +
    +
    Inherits:
    +
    + Base + +
      +
    • Object
    • + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/root_info.rb
    +
    + +
    + +

    Overview

    +
    +

    Example of a serialized RootInfo object:

    + +
    {
    +  ".tag":"user",
    +  "root_namespace_id":"42",
    +  "home_namespace_id":"42"
    +}
    +
    + + +
    +
    +
    + + +
    + + + + + + + +

    + Class Method Summary + collapse +

    + + + + + + + + + + + + + +

    Methods inherited from Base

    +

    field, #initialize, #serialized_field, #to_hash

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Metadata::Base

    + +
    + + +
    +

    Class Method Details

    + + +
    +

    + + .new(data) ⇒ Object + + + + + +

    + + + + + +
    +
    +
    +
    +14
    +15
    +16
    +
    +
    # File 'lib/dropbox_api/metadata/root_info.rb', line 14
    +
    +def new(data)
    +  class_for(data['.tag'].to_sym).new(data)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/SearchMatchFieldOptions.html b/docs/DropboxApi/Metadata/SearchMatchFieldOptions.html new file mode 100644 index 00000000..b0d2a37f --- /dev/null +++ b/docs/DropboxApi/Metadata/SearchMatchFieldOptions.html @@ -0,0 +1,140 @@ + + + + + + + Class: DropboxApi::Metadata::SearchMatchFieldOptions + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::SearchMatchFieldOptions + + + +

    +
    + +
    +
    Inherits:
    +
    + Base + +
      +
    • Object
    • + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/search_match_field_options.rb
    +
    + +
    + + + + + + + + + + + + + + + +

    Method Summary

    + +

    Methods inherited from Base

    +

    field, #initialize, #serialized_field, #to_hash

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Metadata::Base

    + +
    + + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/SearchMatchTypeV2.html b/docs/DropboxApi/Metadata/SearchMatchTypeV2.html new file mode 100644 index 00000000..c851525c --- /dev/null +++ b/docs/DropboxApi/Metadata/SearchMatchTypeV2.html @@ -0,0 +1,244 @@ + + + + + + + Class: DropboxApi::Metadata::SearchMatchTypeV2 + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::SearchMatchTypeV2 + + + +

    +
    + +
    +
    Inherits:
    +
    + Tag + +
      +
    • Object
    • + + + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/search_match_type_v2.rb
    +
    + +
    + + + +

    + Constant Summary + collapse +

    + +
    + +
    VALID_VALUES = + +
    +
    %i[
    +  filename
    +  file_content
    +  filename_and_content
    +  image_content
    +].freeze
    + +
    + + + + + + + + + +

    + Class Method Summary + collapse +

    + + + + + + + + + + + + + +

    Methods inherited from Tag

    +

    new, validate

    + + + + + + + + + +

    Methods inherited from Base

    +

    field, #initialize, #serialized_field, #to_hash

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Metadata::Base

    + +
    + + +
    +

    Class Method Details

    + + +
    +

    + + .valid_valuesObject + + + + + +

    + + + + + +
    +
    +
    +
    +12
    +13
    +14
    +
    +
    # File 'lib/dropbox_api/metadata/search_match_type_v2.rb', line 12
    +
    +def self.valid_values
    +  VALID_VALUES
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/SearchMatchV2.html b/docs/DropboxApi/Metadata/SearchMatchV2.html new file mode 100644 index 00000000..52d7ee9a --- /dev/null +++ b/docs/DropboxApi/Metadata/SearchMatchV2.html @@ -0,0 +1,216 @@ + + + + + + + Class: DropboxApi::Metadata::SearchMatchV2 + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::SearchMatchV2 + + + +

    +
    + +
    +
    Inherits:
    +
    + Base + +
      +
    • Object
    • + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/search_match_v2.rb
    +
    + +
    + + + + + + + + + +

    + Instance Method Summary + collapse +

    + + + + + + + + + + + + + +

    Methods inherited from Base

    +

    field, #initialize, #serialized_field, #to_hash

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Metadata::Base

    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #resourceObject + + + + + +

    + + + + + +
    +
    +
    +
    +11
    +12
    +13
    +14
    +15
    +16
    +
    +
    # File 'lib/dropbox_api/metadata/search_match_v2.rb', line 11
    +
    +def resource
    +  # for some strange reason, v2 of this search endpoint doesn't have
    +  # the `resource` field anymore and file metadata is wrapped in a
    +  # metadata/metadata field...
    +  .
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/SearchOptions.html b/docs/DropboxApi/Metadata/SearchOptions.html new file mode 100644 index 00000000..5328fd96 --- /dev/null +++ b/docs/DropboxApi/Metadata/SearchOptions.html @@ -0,0 +1,140 @@ + + + + + + + Class: DropboxApi::Metadata::SearchOptions + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::SearchOptions + + + +

    +
    + +
    +
    Inherits:
    +
    + Base + +
      +
    • Object
    • + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/search_options.rb
    +
    + +
    + + + + + + + + + + + + + + + +

    Method Summary

    + +

    Methods inherited from Base

    +

    field, #initialize, #serialized_field, #to_hash

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Metadata::Base

    + +
    + + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/SearchOrderBy.html b/docs/DropboxApi/Metadata/SearchOrderBy.html new file mode 100644 index 00000000..930321e7 --- /dev/null +++ b/docs/DropboxApi/Metadata/SearchOrderBy.html @@ -0,0 +1,242 @@ + + + + + + + Class: DropboxApi::Metadata::SearchOrderBy + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::SearchOrderBy + + + +

    +
    + +
    +
    Inherits:
    +
    + Tag + +
      +
    • Object
    • + + + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/search_order_by.rb
    +
    + +
    + + + +

    + Constant Summary + collapse +

    + +
    + +
    VALID_VALUES = + +
    +
    %i[
    +  relevance
    +  last_modified_time
    +].freeze
    + +
    + + + + + + + + + +

    + Class Method Summary + collapse +

    + + + + + + + + + + + + + +

    Methods inherited from Tag

    +

    new, validate

    + + + + + + + + + +

    Methods inherited from Base

    +

    field, #initialize, #serialized_field, #to_hash

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Metadata::Base

    + +
    + + +
    +

    Class Method Details

    + + +
    +

    + + .valid_valuesObject + + + + + +

    + + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/dropbox_api/metadata/search_order_by.rb', line 10
    +
    +def self.valid_values
    +  VALID_VALUES
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/SharedFolder.html b/docs/DropboxApi/Metadata/SharedFolder.html index 941c15bf..b5c1bd5a 100644 --- a/docs/DropboxApi/Metadata/SharedFolder.html +++ b/docs/DropboxApi/Metadata/SharedFolder.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::SharedFolder - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -155,9 +155,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/SharedFolderPolicy.html b/docs/DropboxApi/Metadata/SharedFolderPolicy.html index 7ddfa8e7..6235b836 100644 --- a/docs/DropboxApi/Metadata/SharedFolderPolicy.html +++ b/docs/DropboxApi/Metadata/SharedFolderPolicy.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::SharedFolderPolicy - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -146,9 +146,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/SharedLink.html b/docs/DropboxApi/Metadata/SharedLink.html index 2cf50aa9..71879331 100644 --- a/docs/DropboxApi/Metadata/SharedLink.html +++ b/docs/DropboxApi/Metadata/SharedLink.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::SharedLink - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -229,7 +229,7 @@

    -

    Returns a new instance of SharedLink

    +

    Returns a new instance of SharedLink.

    @@ -244,7 +244,6 @@

     
     
    -5
     6
     7
     8
    @@ -254,16 +253,17 @@ 

    12 13 14 -15

    +15 +16

    -
    # File 'lib/dropbox_api/metadata/shared_link.rb', line 5
    +      
    # File 'lib/dropbox_api/metadata/shared_link.rb', line 6
     
     def initialize(param)
       @shared_link =
         case param
         when String
    -      {:url => param}
    +      {url: param}
         when Hash
           param
         end
    @@ -298,7 +298,6 @@ 

     
     
    -17
     18
     19
     20
    @@ -308,14 +307,15 @@ 

    24 25 26 -27

    +27 +28

    -
    # File 'lib/dropbox_api/metadata/shared_link.rb', line 17
    +      
    # File 'lib/dropbox_api/metadata/shared_link.rb', line 18
     
     def check_validity
       if @shared_link[:url].nil?
    -    raise ArgumentError, "Missing `:url` option"
    +    raise ArgumentError, 'Missing `:url` option'
       end
     
       @shared_link.keys.each do |key|
    @@ -345,12 +345,12 @@ 

     
     
    -29
     30
    -31
    +31 +32

    -
    # File 'lib/dropbox_api/metadata/shared_link.rb', line 29
    +      
    # File 'lib/dropbox_api/metadata/shared_link.rb', line 30
     
     def to_hash
       @shared_link
    @@ -365,9 +365,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/SharedLinkMetadata.html b/docs/DropboxApi/Metadata/SharedLinkMetadata.html index e617a8a6..cebe0058 100644 --- a/docs/DropboxApi/Metadata/SharedLinkMetadata.html +++ b/docs/DropboxApi/Metadata/SharedLinkMetadata.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::SharedLinkMetadata - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -174,15 +174,15 @@

     
     
    -8
     9
    -10
    +10 +11

    -
    # File 'lib/dropbox_api/metadata/shared_link_metadata.rb', line 8
    +      
    # File 'lib/dropbox_api/metadata/shared_link_metadata.rb', line 9
     
     def new(data)
    -  class_for(data[".tag"].to_sym).new(data)
    +  class_for(data['.tag'].to_sym).new(data)
     end
    @@ -194,9 +194,9 @@

    diff --git a/docs/DropboxApi/Metadata/SpaceAllocation.html b/docs/DropboxApi/Metadata/SpaceAllocation.html index e52e324b..0a71ba81 100644 --- a/docs/DropboxApi/Metadata/SpaceAllocation.html +++ b/docs/DropboxApi/Metadata/SpaceAllocation.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::SpaceAllocation - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -146,9 +146,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/SpaceUsage.html b/docs/DropboxApi/Metadata/SpaceUsage.html index 44372c35..579176c6 100644 --- a/docs/DropboxApi/Metadata/SpaceUsage.html +++ b/docs/DropboxApi/Metadata/SpaceUsage.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::SpaceUsage - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -149,9 +149,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/Tag.html b/docs/DropboxApi/Metadata/Tag.html index 72c19e60..82a830db 100644 --- a/docs/DropboxApi/Metadata/Tag.html +++ b/docs/DropboxApi/Metadata/Tag.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::Tag - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -103,7 +103,7 @@ @@ -206,7 +206,6 @@

     
     
    -3
     4
     5
     6
    @@ -217,17 +216,18 @@ 

    11 12 13 -14

    +14 +15

    -
    # File 'lib/dropbox_api/metadata/tag.rb', line 3
    +      
    # File 'lib/dropbox_api/metadata/tag.rb', line 4
     
     def self.new(data)
       case data
       when ::Symbol
         validate(data)
       when Hash
    -    new(data[".tag"].to_sym)
    +    new(data['.tag'].to_sym)
       when String
         new(data.to_sym)
       else
    @@ -255,16 +255,16 @@ 

     
     
    -16
     17
     18
     19
     20
     21
    -22
    +22 +23

    -
    # File 'lib/dropbox_api/metadata/tag.rb', line 16
    +      
    # File 'lib/dropbox_api/metadata/tag.rb', line 17
     
     def self.validate(value)
       if valid_values.include? value
    @@ -283,9 +283,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/Team.html b/docs/DropboxApi/Metadata/Team.html index 3fbe6a61..8da779fc 100644 --- a/docs/DropboxApi/Metadata/Team.html +++ b/docs/DropboxApi/Metadata/Team.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::Team - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -130,9 +130,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/TeamMemberInfo.html b/docs/DropboxApi/Metadata/TeamMemberInfo.html index d786d89b..3deaad6f 100644 --- a/docs/DropboxApi/Metadata/TeamMemberInfo.html +++ b/docs/DropboxApi/Metadata/TeamMemberInfo.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::TeamMemberInfo - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -150,9 +150,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/TeamRootInfo.html b/docs/DropboxApi/Metadata/TeamRootInfo.html new file mode 100644 index 00000000..ea9d11c2 --- /dev/null +++ b/docs/DropboxApi/Metadata/TeamRootInfo.html @@ -0,0 +1,140 @@ + + + + + + + Class: DropboxApi::Metadata::TeamRootInfo + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::TeamRootInfo + + + +

    +
    + +
    +
    Inherits:
    +
    + Base + +
      +
    • Object
    • + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/team_root_info.rb
    +
    + +
    + + + + + + + + + + + + + + + +

    Method Summary

    + +

    Methods inherited from Base

    +

    field, #initialize, #serialized_field, #to_hash

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Metadata::Base

    + +
    + + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/ThumbnailBatchResultData.html b/docs/DropboxApi/Metadata/ThumbnailBatchResultData.html index e16ea9fc..0d6aaf90 100644 --- a/docs/DropboxApi/Metadata/ThumbnailBatchResultData.html +++ b/docs/DropboxApi/Metadata/ThumbnailBatchResultData.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::ThumbnailBatchResultData - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -130,9 +130,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry.html b/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry.html index f375ac5e..e043ee3c 100644 --- a/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry.html +++ b/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::ThumbnailBatchResultEntry - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -177,7 +177,6 @@

     
     
    -11
     12
     13
     14
    @@ -186,17 +185,18 @@ 

    17 18 19 -20

    +20 +21

    -
    # File 'lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb', line 11
    +      
    # File 'lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb', line 12
     
     def new(data)
    -  case data[".tag"].to_sym
    +  case data['.tag'].to_sym
       when :success
         DropboxApi::Metadata::ThumbnailBatchResultData.new(data)
       when :failure
    -    DropboxApi::Errors::ThumbnailError.build("Thumbnail generation failed", data["failure"])
    +    DropboxApi::Errors::ThumbnailError.build('Thumbnail generation failed', data['failure'])
       else
         raise NotImplementedError, "Unknown result type: #{data[".tag"]}"
       end
    @@ -211,9 +211,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/UploadSessionCursor.html b/docs/DropboxApi/Metadata/UploadSessionCursor.html index 56198a50..9bdad52e 100644 --- a/docs/DropboxApi/Metadata/UploadSessionCursor.html +++ b/docs/DropboxApi/Metadata/UploadSessionCursor.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::UploadSessionCursor - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -196,12 +196,12 @@

     
     
    -14
     15
    -16
    +16 +17

    -
    # File 'lib/dropbox_api/metadata/upload_session_cursor.rb', line 14
    +      
    # File 'lib/dropbox_api/metadata/upload_session_cursor.rb', line 15
     
     def offset=(n)
       self[:offset] = n
    @@ -216,9 +216,9 @@ 

    diff --git a/docs/DropboxApi/Metadata/UserRootInfo.html b/docs/DropboxApi/Metadata/UserRootInfo.html new file mode 100644 index 00000000..ff8f1c05 --- /dev/null +++ b/docs/DropboxApi/Metadata/UserRootInfo.html @@ -0,0 +1,140 @@ + + + + + + + Class: DropboxApi::Metadata::UserRootInfo + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Metadata::UserRootInfo + + + +

    +
    + +
    +
    Inherits:
    +
    + Base + +
      +
    • Object
    • + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/metadata/user_root_info.rb
    +
    + +
    + + + + + + + + + + + + + + + +

    Method Summary

    + +

    Methods inherited from Base

    +

    field, #initialize, #serialized_field, #to_hash

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Metadata::Base

    + +
    + + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Metadata/VideoMetadata.html b/docs/DropboxApi/Metadata/VideoMetadata.html index 673893c0..5505f533 100644 --- a/docs/DropboxApi/Metadata/VideoMetadata.html +++ b/docs/DropboxApi/Metadata/VideoMetadata.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::VideoMetadata - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -155,9 +155,9 @@

    Constructor Details

    diff --git a/docs/DropboxApi/Metadata/WriteMode.html b/docs/DropboxApi/Metadata/WriteMode.html index 9556dcf7..33f44c29 100644 --- a/docs/DropboxApi/Metadata/WriteMode.html +++ b/docs/DropboxApi/Metadata/WriteMode.html @@ -6,15 +6,15 @@ Class: DropboxApi::Metadata::WriteMode - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -271,7 +271,7 @@

    -

    Returns a new instance of WriteMode

    +

    Returns a new instance of WriteMode.

    @@ -306,7 +306,6 @@

     
     
    -45
     46
     47
     48
    @@ -319,10 +318,11 @@ 

    55 56 57 -58

    +58 +59

    -
    # File 'lib/dropbox_api/metadata/write_mode.rb', line 45
    +      
    # File 'lib/dropbox_api/metadata/write_mode.rb', line 46
     
     def initialize(write_mode, options = nil)
       case write_mode
    @@ -330,11 +330,11 @@ 

    @write_mode = write_mode when String, ::Symbol @write_mode = { - ".tag" => write_mode + '.tag' => write_mode } @write_mode[write_mode.to_s] = options unless options.nil? end - @write_mode[".tag"] = @write_mode[".tag"].to_sym + @write_mode['.tag'] = @write_mode['.tag'].to_sym check_validity end

    @@ -366,7 +366,6 @@

     
     
    -60
     61
     62
     63
    @@ -374,18 +373,19 @@ 

    65 66 67 -68

    +68 +69

    -
    # File 'lib/dropbox_api/metadata/write_mode.rb', line 60
    +      
    # File 'lib/dropbox_api/metadata/write_mode.rb', line 61
     
     def check_validity
    -  unless valid_mode? @write_mode[".tag"]
    +  unless valid_mode? @write_mode['.tag']
         raise ArgumentError, "Invalid write mode: #{@write_mode[".tag"]}"
       end
     
    -  if @write_mode[".tag"] == :update && @write_mode["update"].nil?
    -    raise ArgumentError, "Mode `:update` expects a `rev` number"
    +  if @write_mode['.tag'] == :update && @write_mode['update'].nil?
    +    raise ArgumentError, 'Mode `:update` expects a `rev` number'
       end
     end
    @@ -409,12 +409,12 @@

     
     
    -70
     71
    -72
    +72 +73

    -
    # File 'lib/dropbox_api/metadata/write_mode.rb', line 70
    +      
    # File 'lib/dropbox_api/metadata/write_mode.rb', line 71
     
     def to_hash
       @write_mode
    @@ -429,9 +429,9 @@ 

    diff --git a/docs/DropboxApi/MiddleWare.html b/docs/DropboxApi/MiddleWare.html index 98ab1f54..9028f9fe 100644 --- a/docs/DropboxApi/MiddleWare.html +++ b/docs/DropboxApi/MiddleWare.html @@ -6,15 +6,15 @@ Module: DropboxApi::MiddleWare - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -79,7 +79,7 @@
    Defined in:
    lib/dropbox_api/middleware/stack.rb,
    - lib/dropbox_api/middleware/decode_result.rb
    + lib/dropbox_api/middleware/path_root.rb,
    lib/dropbox_api/middleware/decode_result.rb
    @@ -91,7 +91,7 @@

    Defined Under Namespace

    - Classes: DecodeResult, Stack + Classes: DecodeResult, PathRoot, Stack

    @@ -107,9 +107,9 @@

    Defined Under Namespace

    diff --git a/docs/DropboxApi/MiddleWare/DecodeResult.html b/docs/DropboxApi/MiddleWare/DecodeResult.html index c160c344..6a558e20 100644 --- a/docs/DropboxApi/MiddleWare/DecodeResult.html +++ b/docs/DropboxApi/MiddleWare/DecodeResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::MiddleWare::DecodeResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -186,7 +186,6 @@

     
     
    -3
     4
     5
     6
    @@ -194,10 +193,11 @@ 

    8 9 10 -11

    +11 +12

    -
    # File 'lib/dropbox_api/middleware/decode_result.rb', line 3
    +      
    # File 'lib/dropbox_api/middleware/decode_result.rb', line 4
     
     def call(rq_env)
       @app.call(rq_env).on_complete do |rs_env|
    @@ -229,7 +229,6 @@ 

     
     
    -13
     14
     15
     16
    @@ -238,16 +237,17 @@ 

    19 20 21 -22

    +22 +23

    -
    # File 'lib/dropbox_api/middleware/decode_result.rb', line 13
    +      
    # File 'lib/dropbox_api/middleware/decode_result.rb', line 14
     
     def decode(json)
       # Dropbox may send a response with the string 'null' in its body, this
       # would be a void result. `add_folder_member` is an example of an
       # endpoint without return values.
    -  if json == "null"
    +  if json == 'null'
         {}
       else
         JSON.parse json
    @@ -263,9 +263,9 @@ 

    diff --git a/docs/DropboxApi/MiddleWare/PathRoot.html b/docs/DropboxApi/MiddleWare/PathRoot.html new file mode 100644 index 00000000..11ab41cc --- /dev/null +++ b/docs/DropboxApi/MiddleWare/PathRoot.html @@ -0,0 +1,412 @@ + + + + + + + Class: DropboxApi::MiddleWare::PathRoot + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::MiddleWare::PathRoot + + + +

    +
    + +
    +
    Inherits:
    +
    + Faraday::Middleware + +
      +
    • Object
    • + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/middleware/path_root.rb
    +
    + +
    + + + +

    + Constant Summary + collapse +

    + +
    + +
    HEADER_NAME = + +
    +
    'Dropbox-API-Path-Root'
    + +
    + + + + + + + + + +

    + Instance Method Summary + collapse +

    + + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(app, options = {}) ⇒ PathRoot + + + + + +

    +
    +

    Returns a new instance of PathRoot.

    + + +
    +
    +
    + + +
    + + + + + +
    +
    +
    +
    +6
    +7
    +8
    +9
    +
    +
    # File 'lib/dropbox_api/middleware/path_root.rb', line 6
    +
    +def initialize(app, options = {})
    +  super(app)
    +  @options = options
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #call(env) ⇒ Object + + + + + +

    + + + + + +
    +
    +
    +
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +
    +
    # File 'lib/dropbox_api/middleware/path_root.rb', line 27
    +
    +def call(env)
    +  if !namespace_id.nil?
    +    env[:request_headers][HEADER_NAME] ||= namespace_id_header_value
    +  end
    +
    +  @app.call env
    +end
    +
    +
    + +
    +

    + + #namespace_idObject + + + + + +

    + + + + + +
    +
    +
    +
    +11
    +12
    +13
    +14
    +15
    +16
    +17
    +
    +
    # File 'lib/dropbox_api/middleware/path_root.rb', line 11
    +
    +def namespace_id
    +  if @options[:namespace_id].nil?
    +    return nil
    +  else
    +    return @options[:namespace_id]
    +  end
    +end
    +
    +
    + +
    +

    + + #namespace_id_header_valueObject + + + + + +

    + + + + + +
    +
    +
    +
    +19
    +20
    +21
    +22
    +23
    +24
    +25
    +
    +
    # File 'lib/dropbox_api/middleware/path_root.rb', line 19
    +
    +def namespace_id_header_value
    +  JSON.dump(
    +    DropboxApi::Metadata::NamespaceId.new({
    +      'namespace_id' => namespace_id
    +    }).to_hash
    +  )
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/MiddleWare/Stack.html b/docs/DropboxApi/MiddleWare/Stack.html index c9d2d7ae..cb578247 100644 --- a/docs/DropboxApi/MiddleWare/Stack.html +++ b/docs/DropboxApi/MiddleWare/Stack.html @@ -6,15 +6,15 @@ Class: DropboxApi::MiddleWare::Stack - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -244,7 +244,7 @@

    -

    Returns a new instance of Stack

    +

    Returns a new instance of Stack.

    @@ -259,12 +259,12 @@

     
     
    -3
     4
    -5
    +5 +6

    -
    # File 'lib/dropbox_api/middleware/stack.rb', line 3
    +      
    # File 'lib/dropbox_api/middleware/stack.rb', line 4
     
     def initialize
       @prependable, @appendable = [], []
    @@ -297,12 +297,12 @@ 

     
     
    -15
     16
    -17
    +17 +18

    -
    # File 'lib/dropbox_api/middleware/stack.rb', line 15
    +      
    # File 'lib/dropbox_api/middleware/stack.rb', line 16
     
     def adapter=(value)
       @adapter = value
    @@ -328,12 +328,12 @@ 

     
     
    -11
     12
    -13
    +13 +14

    -
    # File 'lib/dropbox_api/middleware/stack.rb', line 11
    +      
    # File 'lib/dropbox_api/middleware/stack.rb', line 12
     
     def append(&block)
       @appendable << block
    @@ -381,17 +381,17 @@ 

     
     
    -19
     20
     21
     22
     23
     24
     25
    -26
    +26 +27

    -
    # File 'lib/dropbox_api/middleware/stack.rb', line 19
    +      
    # File 'lib/dropbox_api/middleware/stack.rb', line 20
     
     def apply(connection)
       @prependable.each { |block| block.yield(connection) }
    @@ -422,12 +422,12 @@ 

     
     
    -7
     8
    -9
    +9 +10

    -
    # File 'lib/dropbox_api/middleware/stack.rb', line 7
    +      
    # File 'lib/dropbox_api/middleware/stack.rb', line 8
     
     def prepend(&block)
       @prependable << block
    @@ -442,9 +442,9 @@ 

    diff --git a/docs/DropboxApi/OptionsValidator.html b/docs/DropboxApi/OptionsValidator.html index 205ab418..b63ec9be 100644 --- a/docs/DropboxApi/OptionsValidator.html +++ b/docs/DropboxApi/OptionsValidator.html @@ -6,15 +6,15 @@ Module: DropboxApi::OptionsValidator - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -76,7 +76,7 @@
    Included in:
    -
    ChunkedUploader, Endpoints::Files::CopyBatch, Endpoints::Files::CreateFolderBatch, Endpoints::Files::Delete, Endpoints::Files::GetMetadata, Endpoints::Files::GetThumbnail, Endpoints::Files::GetThumbnailBatch, Endpoints::Files::ListFolder, Endpoints::Files::ListFolderGetLatestCursor, Endpoints::Files::ListFolderLongpoll, Endpoints::Files::ListRevisions, Endpoints::Files::Move, Endpoints::Files::PermanentlyDelete, Endpoints::Files::Search, Endpoints::Files::Upload, Endpoints::Files::UploadSessionAppendV2, Endpoints::Files::UploadSessionFinish, Endpoints::Files::UploadSessionStart, Endpoints::Sharing::AddFileMember, Endpoints::Sharing::AddFolderMember, Endpoints::Sharing::CreateSharedLinkWithSettings, Endpoints::Sharing::GetSharedLinkMetadata, Endpoints::Sharing::ListFileMembers, Endpoints::Sharing::ListFolderMembers, Endpoints::Sharing::ListSharedLinks, Endpoints::Sharing::ShareFolder
    +
    ChunkedUploader, Endpoints::Files::CopyBatch, Endpoints::Files::CreateFolderBatch, Endpoints::Files::Delete, Endpoints::Files::GetMetadata, Endpoints::Files::GetThumbnail, Endpoints::Files::GetThumbnailBatch, Endpoints::Files::ListFolder, Endpoints::Files::ListFolderGetLatestCursor, Endpoints::Files::ListFolderLongpoll, Endpoints::Files::ListRevisions, Endpoints::Files::Move, Endpoints::Files::PermanentlyDelete, Endpoints::Files::Search, Endpoints::Files::SearchContinue, Endpoints::Files::Upload, Endpoints::Files::UploadSessionAppendV2, Endpoints::Files::UploadSessionFinish, Endpoints::Files::UploadSessionStart, Endpoints::Sharing::AddFileMember, Endpoints::Sharing::AddFolderMember, Endpoints::Sharing::CreateSharedLinkWithSettings, Endpoints::Sharing::GetSharedLinkMetadata, Endpoints::Sharing::ListFileMembers, Endpoints::Sharing::ListFolderMembers, Endpoints::Sharing::ListSharedLinks, Endpoints::Sharing::ShareFolder
    @@ -196,16 +196,16 @@

     
     
    -8
     9
     10
     11
     12
     13
    -14
    +14 +15

    -
    # File 'lib/dropbox_api/options_validator.rb', line 8
    +      
    # File 'lib/dropbox_api/options_validator.rb', line 9
     
     def validate_options(valid_option_keys, options)
       options.keys.each do |key|
    @@ -224,9 +224,9 @@ 

    diff --git a/docs/DropboxApi/ResultBuilder.html b/docs/DropboxApi/ResultBuilder.html index da2215c3..2c8b6067 100644 --- a/docs/DropboxApi/ResultBuilder.html +++ b/docs/DropboxApi/ResultBuilder.html @@ -6,15 +6,15 @@ Class: DropboxApi::ResultBuilder - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -288,7 +288,7 @@

    -

    Returns a new instance of ResultBuilder

    +

    Returns a new instance of ResultBuilder.

    @@ -303,12 +303,12 @@

     
     
    -3
     4
    -5
    +5 +6

    -
    # File 'lib/dropbox_api/result_builder.rb', line 3
    +      
    # File 'lib/dropbox_api/result_builder.rb', line 4
     
     def initialize(response_data)
       @response_data = response_data
    @@ -341,12 +341,12 @@ 

     
     
    -23
     24
    -25
    +25 +26

    -
    # File 'lib/dropbox_api/result_builder.rb', line 23
    +      
    # File 'lib/dropbox_api/result_builder.rb', line 24
     
     def build(result_class)
       result_class.new(@response_data)
    @@ -372,12 +372,12 @@ 

     
     
    -27
     28
    -29
    +29 +30

    -
    # File 'lib/dropbox_api/result_builder.rb', line 27
    +      
    # File 'lib/dropbox_api/result_builder.rb', line 28
     
     def build_error(error_type)
       error_type.build(error_summary, error)
    @@ -403,15 +403,15 @@ 

     
     
    -11
     12
    -13
    +13 +14

    -
    # File 'lib/dropbox_api/result_builder.rb', line 11
    +      
    # File 'lib/dropbox_api/result_builder.rb', line 12
     
     def error
    -  @response_data["error"]
    +  @response_data['error']
     end
    @@ -434,15 +434,15 @@

     
     
    -7
     8
    -9
    +9 +10

    -
    # File 'lib/dropbox_api/result_builder.rb', line 7
    +      
    # File 'lib/dropbox_api/result_builder.rb', line 8
     
     def error_summary
    -  @response_data["error_summary"] if @response_data.is_a? Hash
    +  @response_data['error_summary'] if @response_data.is_a? Hash
     end
    @@ -487,12 +487,12 @@

     
     
    -15
     16
    -17
    +17 +18

    -
    # File 'lib/dropbox_api/result_builder.rb', line 15
    +      
    # File 'lib/dropbox_api/result_builder.rb', line 16
     
     def has_error?
       !error_summary.nil?
    @@ -540,12 +540,12 @@ 

     
     
    -19
     20
    -21
    +21 +22

    -
    # File 'lib/dropbox_api/result_builder.rb', line 19
    +      
    # File 'lib/dropbox_api/result_builder.rb', line 20
     
     def success?
       !has_error?
    @@ -560,9 +560,9 @@ 

    diff --git a/docs/DropboxApi/Results.html b/docs/DropboxApi/Results.html index 78545142..ea93ed49 100644 --- a/docs/DropboxApi/Results.html +++ b/docs/DropboxApi/Results.html @@ -6,15 +6,15 @@ Module: DropboxApi::Results - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -79,7 +79,7 @@
    Defined in:
    lib/dropbox_api/results/base.rb,
    - lib/dropbox_api/results/void_result.rb,
    lib/dropbox_api/results/search_result.rb,
    lib/dropbox_api/results/save_url_result.rb,
    lib/dropbox_api/results/copy_batch_result.rb,
    lib/dropbox_api/results/list_folder_result.rb,
    lib/dropbox_api/results/basic_account_batch.rb,
    lib/dropbox_api/results/delete_batch_result.rb,
    lib/dropbox_api/results/save_url_job_status.rb,
    lib/dropbox_api/results/share_folder_launch.rb,
    lib/dropbox_api/results/shared_file_members.rb,
    lib/dropbox_api/results/upload_session_start.rb,
    lib/dropbox_api/results/list_revisions_result.rb,
    lib/dropbox_api/results/shared_folder_members.rb,
    lib/dropbox_api/results/relocation_batch_result.rb,
    lib/dropbox_api/results/list_shared_links_result.rb,
    lib/dropbox_api/results/delete_batch_result_entry.rb,
    lib/dropbox_api/results/get_copy_reference_result.rb,
    lib/dropbox_api/results/get_temporary_link_result.rb,
    lib/dropbox_api/results/create_folder_batch_result.rb,
    lib/dropbox_api/results/get_thumbnail_batch_result.rb,
    lib/dropbox_api/results/save_copy_reference_result.rb,
    lib/dropbox_api/results/add_file_member_result_list.rb,
    lib/dropbox_api/results/list_folder_longpoll_result.rb,
    lib/dropbox_api/results/relocation_batch_result_entry.rb,
    lib/dropbox_api/results/create_folder_batch_result_entry.rb,
    lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb
    + lib/dropbox_api/results/void_result.rb,
    lib/dropbox_api/results/save_url_result.rb,
    lib/dropbox_api/results/search_v2_result.rb,
    lib/dropbox_api/results/copy_batch_result.rb,
    lib/dropbox_api/results/list_folder_result.rb,
    lib/dropbox_api/results/basic_account_batch.rb,
    lib/dropbox_api/results/delete_batch_result.rb,
    lib/dropbox_api/results/save_url_job_status.rb,
    lib/dropbox_api/results/share_folder_launch.rb,
    lib/dropbox_api/results/shared_file_members.rb,
    lib/dropbox_api/results/upload_session_start.rb,
    lib/dropbox_api/results/list_revisions_result.rb,
    lib/dropbox_api/results/shared_folder_members.rb,
    lib/dropbox_api/results/relocation_batch_result.rb,
    lib/dropbox_api/results/list_shared_links_result.rb,
    lib/dropbox_api/results/delete_batch_result_entry.rb,
    lib/dropbox_api/results/get_copy_reference_result.rb,
    lib/dropbox_api/results/get_temporary_link_result.rb,
    lib/dropbox_api/results/create_folder_batch_result.rb,
    lib/dropbox_api/results/get_thumbnail_batch_result.rb,
    lib/dropbox_api/results/save_copy_reference_result.rb,
    lib/dropbox_api/results/add_file_member_result_list.rb,
    lib/dropbox_api/results/list_folder_longpoll_result.rb,
    lib/dropbox_api/results/relocation_batch_result_entry.rb,
    lib/dropbox_api/results/create_folder_batch_result_entry.rb,
    lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb
    @@ -93,7 +93,7 @@

    Defined Under Namespace

    - Classes: AddFileMemberResultList, Base, BasicAccountBatch, CopyBatchResult, CreateFolderBatchResult, CreateFolderBatchResultEntry, DeleteBatchResult, DeleteBatchResultEntry, GetCopyReferenceResult, GetTemporaryLinkResult, GetThumbnailBatchResult, ListFolderGetLatestCursorResult, ListFolderLongpollResult, ListFolderResult, ListRevisionsResult, ListSharedLinksResult, RelocationBatchResult, RelocationBatchResultEntry, SaveCopyReferenceResult, SaveUrlJobStatus, SaveUrlResult, SearchResult, ShareFolderLaunch, SharedFileMembers, SharedFolderMembers, UploadSessionStart, VoidResult + Classes: AddFileMemberResultList, Base, BasicAccountBatch, CopyBatchResult, CreateFolderBatchResult, CreateFolderBatchResultEntry, DeleteBatchResult, DeleteBatchResultEntry, GetCopyReferenceResult, GetTemporaryLinkResult, GetThumbnailBatchResult, ListFolderGetLatestCursorResult, ListFolderLongpollResult, ListFolderResult, ListRevisionsResult, ListSharedLinksResult, RelocationBatchResult, RelocationBatchResultEntry, SaveCopyReferenceResult, SaveUrlJobStatus, SaveUrlResult, SearchV2Result, ShareFolderLaunch, SharedFileMembers, SharedFolderMembers, UploadSessionStart, VoidResult

    @@ -109,9 +109,9 @@

    Defined Under Namespace

    diff --git a/docs/DropboxApi/Results/AddFileMemberResultList.html b/docs/DropboxApi/Results/AddFileMemberResultList.html index 21857351..5cea7e5d 100644 --- a/docs/DropboxApi/Results/AddFileMemberResultList.html +++ b/docs/DropboxApi/Results/AddFileMemberResultList.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::AddFileMemberResultList - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -181,7 +181,7 @@

    -

    Returns a new instance of AddFileMemberResultList

    +

    Returns a new instance of AddFileMemberResultList.

    @@ -196,12 +196,12 @@

     
     
    -16
     17
    -18
    +18 +19

    -
    # File 'lib/dropbox_api/results/add_file_member_result_list.rb', line 16
    +      
    # File 'lib/dropbox_api/results/add_file_member_result_list.rb', line 17
     
     def initialize(members)
       super(members.map { |m| DropboxApi::Metadata::AddFileMemberResult.new m })
    @@ -217,9 +217,9 @@ 

    diff --git a/docs/DropboxApi/Results/Base.html b/docs/DropboxApi/Results/Base.html index 4e5bf80d..87f0faa1 100644 --- a/docs/DropboxApi/Results/Base.html +++ b/docs/DropboxApi/Results/Base.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::Base - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -101,7 +101,7 @@ @@ -160,7 +160,7 @@

    -

    Returns a new instance of Base

    +

    Returns a new instance of Base.

    @@ -175,12 +175,12 @@

     
     
    -3
     4
    -5
    +5 +6

    -
    # File 'lib/dropbox_api/results/base.rb', line 3
    +      
    # File 'lib/dropbox_api/results/base.rb', line 4
     
     def initialize(result_data)
       @data = result_data
    @@ -196,9 +196,9 @@ 

    diff --git a/docs/DropboxApi/Results/BasicAccountBatch.html b/docs/DropboxApi/Results/BasicAccountBatch.html index db7d9b44..af665f63 100644 --- a/docs/DropboxApi/Results/BasicAccountBatch.html +++ b/docs/DropboxApi/Results/BasicAccountBatch.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::BasicAccountBatch - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -159,7 +159,7 @@

    -

    Returns a new instance of BasicAccountBatch

    +

    Returns a new instance of BasicAccountBatch.

    @@ -174,12 +174,12 @@

     
     
    -3
     4
    -5
    +5 +6

    -
    # File 'lib/dropbox_api/results/basic_account_batch.rb', line 3
    +      
    # File 'lib/dropbox_api/results/basic_account_batch.rb', line 4
     
     def initialize(accounts)
       super(accounts.map { |a| DropboxApi::Metadata::BasicAccount.new a })
    @@ -195,9 +195,9 @@ 

    diff --git a/docs/DropboxApi/Results/CopyBatchResult.html b/docs/DropboxApi/Results/CopyBatchResult.html index 4624be27..a4c4f6ba 100644 --- a/docs/DropboxApi/Results/CopyBatchResult.html +++ b/docs/DropboxApi/Results/CopyBatchResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::CopyBatchResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -180,7 +180,6 @@

     
     
    -3
     4
     5
     6
    @@ -189,13 +188,14 @@ 

    9 10 11 -12

    +12 +13

    -
    # File 'lib/dropbox_api/results/copy_batch_result.rb', line 3
    +      
    # File 'lib/dropbox_api/results/copy_batch_result.rb', line 4
     
     def self.new(result_data)
    -  case result_data[".tag"]
    +  case result_data['.tag']
       when 'async_job_id'
         result_data['async_job_id']
       when 'complete'
    @@ -214,9 +214,9 @@ 

    diff --git a/docs/DropboxApi/Results/CreateFolderBatchResult.html b/docs/DropboxApi/Results/CreateFolderBatchResult.html index 961c6fab..682aceb1 100644 --- a/docs/DropboxApi/Results/CreateFolderBatchResult.html +++ b/docs/DropboxApi/Results/CreateFolderBatchResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::CreateFolderBatchResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -193,7 +193,6 @@

     
     
    -7
     8
     9
     10
    @@ -204,17 +203,18 @@ 

    15 16 17 -18

    +18 +19

    -
    # File 'lib/dropbox_api/results/create_folder_batch_result.rb', line 7
    +      
    # File 'lib/dropbox_api/results/create_folder_batch_result.rb', line 8
     
     def self.new(result_data)
    -  case result_data[".tag"]
    -  when "async_job_id"
    +  case result_data['.tag']
    +  when 'async_job_id'
         result_data
    -  when "complete"
    -    result_data["entries"].map do |entry|
    +  when 'complete'
    +    result_data['entries'].map do |entry|
           DropboxApi::Results::CreateFolderBatchResultEntry.new(entry)
         end
       else
    @@ -231,9 +231,9 @@ 

    diff --git a/docs/DropboxApi/Results/CreateFolderBatchResultEntry.html b/docs/DropboxApi/Results/CreateFolderBatchResultEntry.html index 03afea19..73b9d928 100644 --- a/docs/DropboxApi/Results/CreateFolderBatchResultEntry.html +++ b/docs/DropboxApi/Results/CreateFolderBatchResultEntry.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::CreateFolderBatchResultEntry - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -180,7 +180,6 @@

     
     
    -3
     4
     5
     6
    @@ -194,10 +193,11 @@ 

    14 15 16 -17

    +17 +18

    -
    # File 'lib/dropbox_api/results/create_folder_batch_result_entry.rb', line 3
    +      
    # File 'lib/dropbox_api/results/create_folder_batch_result_entry.rb', line 4
     
     def self.new(result_data)
       case result_data['.tag']
    @@ -224,9 +224,9 @@ 

    diff --git a/docs/DropboxApi/Results/DeleteBatchResult.html b/docs/DropboxApi/Results/DeleteBatchResult.html index d27bc338..3e415963 100644 --- a/docs/DropboxApi/Results/DeleteBatchResult.html +++ b/docs/DropboxApi/Results/DeleteBatchResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::DeleteBatchResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -193,7 +193,6 @@

     
     
    -7
     8
     9
     10
    @@ -204,17 +203,18 @@ 

    15 16 17 -18

    +18 +19

    -
    # File 'lib/dropbox_api/results/delete_batch_result.rb', line 7
    +      
    # File 'lib/dropbox_api/results/delete_batch_result.rb', line 8
     
     def self.new(result_data)
    -  case result_data[".tag"]
    -  when "async_job_id"
    +  case result_data['.tag']
    +  when 'async_job_id'
         result_data
    -  when "complete"
    -    result_data["entries"].map do |entry|
    +  when 'complete'
    +    result_data['entries'].map do |entry|
           DropboxApi::Results::DeleteBatchResultEntry.new(entry)
         end
       else
    @@ -231,9 +231,9 @@ 

    diff --git a/docs/DropboxApi/Results/DeleteBatchResultEntry.html b/docs/DropboxApi/Results/DeleteBatchResultEntry.html index b8f7748e..bf52465e 100644 --- a/docs/DropboxApi/Results/DeleteBatchResultEntry.html +++ b/docs/DropboxApi/Results/DeleteBatchResultEntry.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::DeleteBatchResultEntry - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -180,7 +180,6 @@

     
     
    -3
     4
     5
     6
    @@ -190,10 +189,11 @@ 

    10 11 12 -13

    +13 +14

    -
    # File 'lib/dropbox_api/results/delete_batch_result_entry.rb', line 3
    +      
    # File 'lib/dropbox_api/results/delete_batch_result_entry.rb', line 4
     
     def self.new(result_data)
       case result_data['.tag']
    @@ -216,9 +216,9 @@ 

    diff --git a/docs/DropboxApi/Results/GetCopyReferenceResult.html b/docs/DropboxApi/Results/GetCopyReferenceResult.html index 8bd0efd9..48f16677 100644 --- a/docs/DropboxApi/Results/GetCopyReferenceResult.html +++ b/docs/DropboxApi/Results/GetCopyReferenceResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::GetCopyReferenceResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -237,15 +237,15 @@

     
     
    -9
     10
    -11
    +11 +12

    -
    # File 'lib/dropbox_api/results/get_copy_reference_result.rb', line 9
    +      
    # File 'lib/dropbox_api/results/get_copy_reference_result.rb', line 10
     
     def copy_reference
    -  @copy_reference ||= @data["copy_reference"]
    +  @copy_reference ||= @data['copy_reference']
     end
    @@ -280,15 +280,15 @@

     
     
    -16
     17
    -18
    +18 +19

    -
    # File 'lib/dropbox_api/results/get_copy_reference_result.rb', line 16
    +      
    # File 'lib/dropbox_api/results/get_copy_reference_result.rb', line 17
     
     def expires
    -  @expires ||= Time.parse(@data["expires"])
    +  @expires ||= Time.parse(@data['expires'])
     end
    @@ -321,15 +321,15 @@

     
     
    -4
     5
    -6
    +6 +7

    -
    # File 'lib/dropbox_api/results/get_copy_reference_result.rb', line 4
    +      
    # File 'lib/dropbox_api/results/get_copy_reference_result.rb', line 5
     
     def resource
    -  @resource ||= DropboxApi::Metadata::Resource.new @data["metadata"]
    +  @resource ||= DropboxApi::Metadata::Resource.new @data['metadata']
     end
    @@ -341,9 +341,9 @@

    diff --git a/docs/DropboxApi/Results/GetTemporaryLinkResult.html b/docs/DropboxApi/Results/GetTemporaryLinkResult.html index 11111cfd..ee34c9c9 100644 --- a/docs/DropboxApi/Results/GetTemporaryLinkResult.html +++ b/docs/DropboxApi/Results/GetTemporaryLinkResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::GetTemporaryLinkResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -202,15 +202,15 @@

     
     
    -3
     4
    -5
    +5 +6

    -
    # File 'lib/dropbox_api/results/get_temporary_link_result.rb', line 3
    +      
    # File 'lib/dropbox_api/results/get_temporary_link_result.rb', line 4
     
     def file
    -  @file ||= DropboxApi::Metadata::File.new(@data["metadata"])
    +  @file ||= DropboxApi::Metadata::File.new(@data['metadata'])
     end
    @@ -233,15 +233,15 @@
    -
    # File 'lib/dropbox_api/results/get_temporary_link_result.rb', line 7
    +      
    # File 'lib/dropbox_api/results/get_temporary_link_result.rb', line 8
     
     def link
    -  @data["link"]
    +  @data['link']
     end
    @@ -253,9 +253,9 @@

     
     
    -3
     4
     5
     6
    -7
    +7 +8

    -
    # File 'lib/dropbox_api/results/get_thumbnail_batch_result.rb', line 3
    +      
    # File 'lib/dropbox_api/results/get_thumbnail_batch_result.rb', line 4
     
     def entries
    -  @entries ||= @data["entries"].map do |entry|
    +  @entries ||= @data['entries'].map do |entry|
         DropboxApi::Metadata::ThumbnailBatchResultEntry.new entry
       end
     end
    @@ -204,9 +204,9 @@

    diff --git a/docs/DropboxApi/Results/ListFolderGetLatestCursorResult.html b/docs/DropboxApi/Results/ListFolderGetLatestCursorResult.html index 54cf6562..75eefb8d 100644 --- a/docs/DropboxApi/Results/ListFolderGetLatestCursorResult.html +++ b/docs/DropboxApi/Results/ListFolderGetLatestCursorResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::ListFolderGetLatestCursorResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -180,15 +180,15 @@

     
     
    -3
     4
    -5
    +5 +6

    -
    # File 'lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb', line 3
    +      
    # File 'lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb', line 4
     
     def cursor
    -  @data["cursor"]
    +  @data['cursor']
     end
    @@ -200,9 +200,9 @@

    diff --git a/docs/DropboxApi/Results/ListFolderLongpollResult.html b/docs/DropboxApi/Results/ListFolderLongpollResult.html index c55a3e78..0b377377 100644 --- a/docs/DropboxApi/Results/ListFolderLongpollResult.html +++ b/docs/DropboxApi/Results/ListFolderLongpollResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::ListFolderLongpollResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -215,15 +215,15 @@

     
     
    -11
     12
    -13
    +13 +14

    -
    # File 'lib/dropbox_api/results/list_folder_longpoll_result.rb', line 11
    +      
    # File 'lib/dropbox_api/results/list_folder_longpoll_result.rb', line 12
     
     def backoff
    -  @data["backoff"]
    +  @data['backoff']
     end
    @@ -257,15 +257,15 @@

     
     
    -5
     6
    -7
    +7 +8

    -
    # File 'lib/dropbox_api/results/list_folder_longpoll_result.rb', line 5
    +      
    # File 'lib/dropbox_api/results/list_folder_longpoll_result.rb', line 6
     
     def changes
    -  @data["changes"].to_s == "true"
    +  @data['changes'].to_s == 'true'
     end
    @@ -277,9 +277,9 @@

    diff --git a/docs/DropboxApi/Results/ListFolderResult.html b/docs/DropboxApi/Results/ListFolderResult.html index 59f53357..4efbc8a8 100644 --- a/docs/DropboxApi/Results/ListFolderResult.html +++ b/docs/DropboxApi/Results/ListFolderResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::ListFolderResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -238,15 +238,15 @@

     
     
    -12
     13
    -14
    +14 +15

    -
    # File 'lib/dropbox_api/results/list_folder_result.rb', line 12
    +      
    # File 'lib/dropbox_api/results/list_folder_result.rb', line 13
     
     def cursor
    -  @data["cursor"]
    +  @data['cursor']
     end
    @@ -279,17 +279,17 @@

     
     
    -4
     5
     6
     7
    -8
    +8 +9

    -
    # File 'lib/dropbox_api/results/list_folder_result.rb', line 4
    +      
    # File 'lib/dropbox_api/results/list_folder_result.rb', line 5
     
     def entries
    -  @entries ||= @data["entries"].map do |entry|
    +  @entries ||= @data['entries'].map do |entry|
         DropboxApi::Metadata::Resource.new entry
       end
     end
    @@ -338,15 +338,15 @@

     
     
    -18
     19
    -20
    +20 +21

    -
    # File 'lib/dropbox_api/results/list_folder_result.rb', line 18
    +      
    # File 'lib/dropbox_api/results/list_folder_result.rb', line 19
     
     def has_more?
    -  @data["has_more"].to_s == "true"
    +  @data['has_more'].to_s == 'true'
     end
    @@ -358,9 +358,9 @@

    diff --git a/docs/DropboxApi/Results/ListRevisionsResult.html b/docs/DropboxApi/Results/ListRevisionsResult.html index ec7a46f5..1c93d6c8 100644 --- a/docs/DropboxApi/Results/ListRevisionsResult.html +++ b/docs/DropboxApi/Results/ListRevisionsResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::ListRevisionsResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -213,17 +213,17 @@

     
     
    -4
     5
     6
     7
    -8
    +8 +9

    -
    # File 'lib/dropbox_api/results/list_revisions_result.rb', line 4
    +      
    # File 'lib/dropbox_api/results/list_revisions_result.rb', line 5
     
     def entries
    -  @entries ||= @data["entries"].map do |entry|
    +  @entries ||= @data['entries'].map do |entry|
         DropboxApi::Metadata::File.new entry
       end
     end
    @@ -270,15 +270,15 @@

     
     
    -10
     11
    -12
    +12 +13

    -
    # File 'lib/dropbox_api/results/list_revisions_result.rb', line 10
    +      
    # File 'lib/dropbox_api/results/list_revisions_result.rb', line 11
     
     def is_deleted?
    -  @data["is_deleted"] == true
    +  @data['is_deleted'] == true
     end
    @@ -290,9 +290,9 @@

    diff --git a/docs/DropboxApi/Results/ListSharedLinksResult.html b/docs/DropboxApi/Results/ListSharedLinksResult.html index 544812a9..c820e61d 100644 --- a/docs/DropboxApi/Results/ListSharedLinksResult.html +++ b/docs/DropboxApi/Results/ListSharedLinksResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::ListSharedLinksResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -238,15 +238,15 @@

     
     
    -12
     13
    -14
    +14 +15

    -
    # File 'lib/dropbox_api/results/list_shared_links_result.rb', line 12
    +      
    # File 'lib/dropbox_api/results/list_shared_links_result.rb', line 13
     
     def cursor
    -  @data["cursor"]
    +  @data['cursor']
     end
    @@ -293,15 +293,15 @@

     
     
    -18
     19
    -20
    +20 +21

    -
    # File 'lib/dropbox_api/results/list_shared_links_result.rb', line 18
    +      
    # File 'lib/dropbox_api/results/list_shared_links_result.rb', line 19
     
     def has_more?
    -  @data["has_more"].to_s == "true"
    +  @data['has_more'].to_s == 'true'
     end
    @@ -334,17 +334,17 @@
    -
    # File 'lib/dropbox_api/results/list_shared_links_result.rb', line 4
    +      
    # File 'lib/dropbox_api/results/list_shared_links_result.rb', line 5
     
     def links
    -  @entries ||= @data["links"].map do |entry|
    +  @entries ||= @data['links'].map do |entry|
         DropboxApi::Metadata::SharedLinkMetadata.new entry
       end
     end
    @@ -358,9 +358,9 @@

     
     
    -7
     8
     9
     10
    @@ -204,17 +203,18 @@ 

    15 16 17 -18

    +18 +19

    -
    # File 'lib/dropbox_api/results/relocation_batch_result.rb', line 7
    +      
    # File 'lib/dropbox_api/results/relocation_batch_result.rb', line 8
     
     def self.new(result_data)
    -  case result_data[".tag"]
    -  when "in_progress"
    +  case result_data['.tag']
    +  when 'in_progress'
         :in_progress
    -  when "complete"
    -    result_data["entries"].map do |entry|
    +  when 'complete'
    +    result_data['entries'].map do |entry|
           DropboxApi::Results::RelocationBatchResultEntry.new(entry)
         end
       else
    @@ -231,9 +231,9 @@ 

    diff --git a/docs/DropboxApi/Results/RelocationBatchResultEntry.html b/docs/DropboxApi/Results/RelocationBatchResultEntry.html index 99bea50f..757a835a 100644 --- a/docs/DropboxApi/Results/RelocationBatchResultEntry.html +++ b/docs/DropboxApi/Results/RelocationBatchResultEntry.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::RelocationBatchResultEntry - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -180,7 +180,6 @@

     
     
    -3
     4
     5
     6
    @@ -190,10 +189,11 @@ 

    10 11 12 -13

    +13 +14

    -
    # File 'lib/dropbox_api/results/relocation_batch_result_entry.rb', line 3
    +      
    # File 'lib/dropbox_api/results/relocation_batch_result_entry.rb', line 4
     
     def self.new(result_data)
       case result_data['.tag']
    @@ -216,9 +216,9 @@ 

    diff --git a/docs/DropboxApi/Results/SaveCopyReferenceResult.html b/docs/DropboxApi/Results/SaveCopyReferenceResult.html index 548adec6..96018858 100644 --- a/docs/DropboxApi/Results/SaveCopyReferenceResult.html +++ b/docs/DropboxApi/Results/SaveCopyReferenceResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::SaveCopyReferenceResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -191,15 +191,15 @@

     
     
    -4
     5
    -6
    +6 +7

    -
    # File 'lib/dropbox_api/results/save_copy_reference_result.rb', line 4
    +      
    # File 'lib/dropbox_api/results/save_copy_reference_result.rb', line 5
     
     def resource
    -  @resource ||= DropboxApi::Metadata::Resource.new @data["metadata"]
    +  @resource ||= DropboxApi::Metadata::Resource.new @data['metadata']
     end
    @@ -211,9 +211,9 @@

    diff --git a/docs/DropboxApi/Results/SaveUrlJobStatus.html b/docs/DropboxApi/Results/SaveUrlJobStatus.html index b9882178..63f4b4c7 100644 --- a/docs/DropboxApi/Results/SaveUrlJobStatus.html +++ b/docs/DropboxApi/Results/SaveUrlJobStatus.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::SaveUrlJobStatus - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -180,7 +180,6 @@

     
     
    -3
     4
     5
     6
    @@ -192,20 +191,21 @@ 

    12 13 14 -15

    +15 +16

    -
    # File 'lib/dropbox_api/results/save_url_job_status.rb', line 3
    +      
    # File 'lib/dropbox_api/results/save_url_job_status.rb', line 4
     
     def self.new(result_data)
    -  case result_data[".tag"]
    -  when "in_progress"
    +  case result_data['.tag']
    +  when 'in_progress'
         :in_progress
    -  when "complete"
    +  when 'complete'
         DropboxApi::Metadata::File.new result_data
    -  when "failed"
    -    DropboxApi::Errors::SaveUrlError.build("Async job failed",
    -                                           result_data["failed"])
    +  when 'failed'
    +    DropboxApi::Errors::SaveUrlError.build('Async job failed',
    +                                           result_data['failed'])
       else
         raise NotImplementedError, "Unknown result type: #{result_data[".tag"]}"
       end
    @@ -220,9 +220,9 @@ 

    diff --git a/docs/DropboxApi/Results/SaveUrlResult.html b/docs/DropboxApi/Results/SaveUrlResult.html index f98b2bc4..0db50faf 100644 --- a/docs/DropboxApi/Results/SaveUrlResult.html +++ b/docs/DropboxApi/Results/SaveUrlResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::SaveUrlResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -197,15 +197,15 @@

     
     
    -10
     11
    -12
    +12 +13

    -
    # File 'lib/dropbox_api/results/save_url_result.rb', line 10
    +      
    # File 'lib/dropbox_api/results/save_url_result.rb', line 11
     
     def async_job_id
    -  @data["async_job_id"]
    +  @data['async_job_id']
     end
    @@ -217,9 +217,9 @@

    diff --git a/docs/DropboxApi/Results/Search.html b/docs/DropboxApi/Results/Search.html index 8bde858f..0d17d39c 100644 --- a/docs/DropboxApi/Results/Search.html +++ b/docs/DropboxApi/Results/Search.html @@ -6,15 +6,15 @@ Module: DropboxApi::Results::Search - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -105,9 +105,9 @@

    Defined Under Namespace

    diff --git a/docs/DropboxApi/Results/Search/Match.html b/docs/DropboxApi/Results/Search/Match.html index 32c12d2c..4f116263 100644 --- a/docs/DropboxApi/Results/Search/Match.html +++ b/docs/DropboxApi/Results/Search/Match.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::Search::Match - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -200,7 +200,7 @@

    -

    Returns a new instance of Match

    +

    Returns a new instance of Match.

    @@ -215,12 +215,12 @@

     
     
    -3
     4
    -5
    +5 +6

    -
    # File 'lib/dropbox_api/results/search/match.rb', line 3
    +      
    # File 'lib/dropbox_api/results/search/match.rb', line 4
     
     def initialize(data)
       @data = data
    @@ -253,15 +253,15 @@ 

     
     
    -7
     8
    -9
    +9 +10

    -
    # File 'lib/dropbox_api/results/search/match.rb', line 7
    +      
    # File 'lib/dropbox_api/results/search/match.rb', line 8
     
     def match_type
    -  @data["match_type"]
    +  @data['match_type']
     end
    @@ -284,15 +284,15 @@

     
     
    -11
     12
    -13
    +13 +14

    -
    # File 'lib/dropbox_api/results/search/match.rb', line 11
    +      
    # File 'lib/dropbox_api/results/search/match.rb', line 12
     
     def resource
    -  @resource ||= DropboxApi::Metadata::Resource.new @data["metadata"]
    +  @resource ||= DropboxApi::Metadata::Resource.new @data['metadata']
     end
    @@ -304,9 +304,9 @@

    diff --git a/docs/DropboxApi/Results/SearchV2Result.html b/docs/DropboxApi/Results/SearchV2Result.html new file mode 100644 index 00000000..cfaaf6c3 --- /dev/null +++ b/docs/DropboxApi/Results/SearchV2Result.html @@ -0,0 +1,368 @@ + + + + + + + Class: DropboxApi::Results::SearchV2Result + + — Documentation by YARD 0.9.26 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: DropboxApi::Results::SearchV2Result + + + +

    +
    + +
    +
    Inherits:
    +
    + Base + +
      +
    • Object
    • + + + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/dropbox_api/results/search_v2_result.rb
    +
    + +
    + + + + + + + + + +

    + Instance Method Summary + collapse +

    + +
      + +
    • + + + #cursor ⇒ Object + + + + + + + + + + + + + +

      Pass the cursor into #search_continue to fetch the next page of results.

      +
      + +
    • + + +
    • + + + #has_more? ⇒ Boolean + + + + + + + + + + + + + +

      Used for paging.

      +
      + +
    • + + +
    • + + + #matches ⇒ Object + + + + + + + + + + + + + +

      A list (possibly empty) of matches for the query.

      +
      + +
    • + + +
    + + + + + + + + + + + +

    Methods inherited from Base

    +

    #initialize

    +
    +

    Constructor Details

    + +

    This class inherits a constructor from DropboxApi::Results::Base

    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #cursorObject + + + + + +

    +
    +

    Pass the cursor into #search_continue to fetch the next page of results. +This field is optional.

    + + +
    +
    +
    + + +
    + + + + + +
    +
    +
    +
    +19
    +20
    +21
    +
    +
    # File 'lib/dropbox_api/results/search_v2_result.rb', line 19
    +
    +def cursor
    +  @data['cursor']
    +end
    +
    +
    + +
    +

    + + #has_more?Boolean + + + + + +

    +
    +

    Used for paging. If true, indicates there is another page of results +available that can be fetched by calling search again.

    + + +
    +
    +
    + +

    Returns:

    +
      + +
    • + + + (Boolean) + + + +
    • + +
    + +
    + + + + + +
    +
    +
    +
    +13
    +14
    +15
    +
    +
    # File 'lib/dropbox_api/results/search_v2_result.rb', line 13
    +
    +def has_more?
    +  @data['has_more'].to_s == 'true'
    +end
    +
    +
    + +
    +

    + + #matchesObject + + + + + +

    +
    +

    A list (possibly empty) of matches for the query.

    + + +
    +
    +
    + + +
    + + + + + +
    +
    +
    +
    +5
    +6
    +7
    +8
    +9
    +
    +
    # File 'lib/dropbox_api/results/search_v2_result.rb', line 5
    +
    +def matches
    +  @matches ||= @data['matches'].map do |match|
    +    DropboxApi::Metadata::SearchMatchV2.new match
    +  end
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/DropboxApi/Results/ShareFolderLaunch.html b/docs/DropboxApi/Results/ShareFolderLaunch.html index a8c32efd..9f8d9d1f 100644 --- a/docs/DropboxApi/Results/ShareFolderLaunch.html +++ b/docs/DropboxApi/Results/ShareFolderLaunch.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::ShareFolderLaunch - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -161,7 +161,6 @@

     
     
    -3
     4
     5
     6
    @@ -170,16 +169,17 @@ 

    9 10 11 -12

    +12 +13

    -
    # File 'lib/dropbox_api/results/share_folder_launch.rb', line 3
    +      
    # File 'lib/dropbox_api/results/share_folder_launch.rb', line 4
     
     def self.new(result_data)
    -  case result_data[".tag"]
    -  when "complete"
    +  case result_data['.tag']
    +  when 'complete'
         DropboxApi::Metadata::SharedFolder.new result_data
    -  when "async_job_id"
    +  when 'async_job_id'
         result_data
       else
         raise ArgumentError, "Unable to infer resource type for `#{tag}`"
    @@ -195,9 +195,9 @@ 

    diff --git a/docs/DropboxApi/Results/SharedFileMembers.html b/docs/DropboxApi/Results/SharedFileMembers.html index a46abb02..e18618b1 100644 --- a/docs/DropboxApi/Results/SharedFileMembers.html +++ b/docs/DropboxApi/Results/SharedFileMembers.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::SharedFileMembers - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -246,15 +246,15 @@

     
     
    -15
     16
    -17
    +17 +18

    -
    # File 'lib/dropbox_api/results/shared_file_members.rb', line 15
    +      
    # File 'lib/dropbox_api/results/shared_file_members.rb', line 16
     
     def cursor
    -  @data["cursor"]
    +  @data['cursor']
     end
    @@ -277,15 +277,15 @@

     
     
    -7
     8
    -9
    +9 +10

    -
    # File 'lib/dropbox_api/results/shared_file_members.rb', line 7
    +      
    # File 'lib/dropbox_api/results/shared_file_members.rb', line 8
     
     def groups
    -  @data["groups"]
    +  @data['groups']
     end
    @@ -308,15 +308,15 @@

     
     
    -11
     12
    -13
    +13 +14

    -
    # File 'lib/dropbox_api/results/shared_file_members.rb', line 11
    +      
    # File 'lib/dropbox_api/results/shared_file_members.rb', line 12
     
     def invitees
    -  @data["invitees"]
    +  @data['invitees']
     end
    @@ -339,15 +339,15 @@

     
     
    -3
     4
    -5
    +5 +6

    -
    # File 'lib/dropbox_api/results/shared_file_members.rb', line 3
    +      
    # File 'lib/dropbox_api/results/shared_file_members.rb', line 4
     
     def users
    -  @data["users"]
    +  @data['users']
     end
    @@ -359,9 +359,9 @@

    diff --git a/docs/DropboxApi/Results/SharedFolderMembers.html b/docs/DropboxApi/Results/SharedFolderMembers.html index 89a14e95..95c11f3c 100644 --- a/docs/DropboxApi/Results/SharedFolderMembers.html +++ b/docs/DropboxApi/Results/SharedFolderMembers.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::SharedFolderMembers - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -246,15 +246,15 @@

     
     
    -15
     16
    -17
    +17 +18

    -
    # File 'lib/dropbox_api/results/shared_folder_members.rb', line 15
    +      
    # File 'lib/dropbox_api/results/shared_folder_members.rb', line 16
     
     def cursor
    -  @data["cursor"]
    +  @data['cursor']
     end
    @@ -277,15 +277,15 @@

     
     
    -7
     8
    -9
    +9 +10

    -
    # File 'lib/dropbox_api/results/shared_folder_members.rb', line 7
    +      
    # File 'lib/dropbox_api/results/shared_folder_members.rb', line 8
     
     def groups
    -  @data["groups"]
    +  @data['groups']
     end
    @@ -308,15 +308,15 @@

     
     
    -11
     12
    -13
    +13 +14

    -
    # File 'lib/dropbox_api/results/shared_folder_members.rb', line 11
    +      
    # File 'lib/dropbox_api/results/shared_folder_members.rb', line 12
     
     def invitees
    -  @data["invitees"]
    +  @data['invitees']
     end
    @@ -339,15 +339,15 @@

     
     
    -3
     4
    -5
    +5 +6

    -
    # File 'lib/dropbox_api/results/shared_folder_members.rb', line 3
    +      
    # File 'lib/dropbox_api/results/shared_folder_members.rb', line 4
     
     def users
    -  @data["users"]
    +  @data['users']
     end
    @@ -359,9 +359,9 @@

    diff --git a/docs/DropboxApi/Results/UploadSessionStart.html b/docs/DropboxApi/Results/UploadSessionStart.html index 4f06db97..23ba448c 100644 --- a/docs/DropboxApi/Results/UploadSessionStart.html +++ b/docs/DropboxApi/Results/UploadSessionStart.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::UploadSessionStart - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -180,15 +180,15 @@

     
     
    -3
     4
    -5
    +5 +6

    -
    # File 'lib/dropbox_api/results/upload_session_start.rb', line 3
    +      
    # File 'lib/dropbox_api/results/upload_session_start.rb', line 4
     
     def session_id
    -  @data["session_id"]
    +  @data['session_id']
     end
    @@ -200,9 +200,9 @@

    diff --git a/docs/DropboxApi/Results/VoidResult.html b/docs/DropboxApi/Results/VoidResult.html index 276346a0..80a96634 100644 --- a/docs/DropboxApi/Results/VoidResult.html +++ b/docs/DropboxApi/Results/VoidResult.html @@ -6,15 +6,15 @@ Class: DropboxApi::Results::VoidResult - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -130,9 +130,9 @@

    Constructor Details

    diff --git a/docs/DropboxScaffoldBuilder.html b/docs/DropboxScaffoldBuilder.html index 600677f4..a19db694 100644 --- a/docs/DropboxScaffoldBuilder.html +++ b/docs/DropboxScaffoldBuilder.html @@ -6,15 +6,15 @@ Class: DropboxScaffoldBuilder - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -141,7 +141,7 @@

    PREFIX =
    -
    "/dropbox_api_fixtures"
    +
    '/dropbox_api_fixtures'
    @@ -221,6 +221,28 @@

    +
    + + + + +
  • + + + .regenerate_all ⇒ Object + + + + + + + + + + + + +
  • @@ -384,6 +406,28 @@

    +
    + + + + +
  • + + + #build_search ⇒ Object + + + + + + + + + + + + +
  • @@ -564,7 +608,7 @@

    -

    Returns a new instance of DropboxScaffoldBuilder

    +

    Returns a new instance of DropboxScaffoldBuilder.

    @@ -579,12 +623,12 @@

     
     
    -39
    -40
    -41
    +47 +48 +49

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 39
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 47
     
     def initialize(endpoint_name)
       @endpoint_name = endpoint_name.to_s
    @@ -617,12 +661,12 @@ 

     
     
    -33
    -34
    -35
    +41 +42 +43

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 33
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 41
     
     def self.fixtures_path
       File.expand_path('../../fixtures', __FILE__)
    @@ -648,12 +692,12 @@ 

     
     
    -29
    -30
    -31
    +37 +38 +39

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 29
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 37
     
     def self.prefix_for(endpoint_name)
       new(endpoint_name).path_prefix
    @@ -679,14 +723,14 @@ 

     
     
    -23
    -24
    -25
    -26
    -27
    +31 +32 +33 +34 +35

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 23
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 31
     
     def self.regenerate(endpoint_name)
       builder = new(endpoint_name)
    @@ -696,6 +740,43 @@ 

    + + +
    +

    + + .regenerate_allObject + + + + + +

    + + + + + +
    +
    +
    +
    +24
    +25
    +26
    +27
    +28
    +29
    +
    +
    # File 'spec/support/dropbox_scaffold_builder.rb', line 24
    +
    +def self.regenerate_all
    +  public_instance_methods
    +    .map(&:to_s)
    +    .select { |method_name| method_name.start_with?('build') }
    +    .each { |method_name| regenerate(method_name.sub('build_', '')) }
    +end
    +
    @@ -720,17 +801,17 @@

     
     
    -57
    -58
    -59
    -60
    +65 +66 +67 +68

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 57
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 65
     
     def build_copy_batch
    -  client.upload("#{path_prefix}/regular_file.txt", "Che primo! aon vas?")
    -  client.upload("#{path_prefix}/regular_file_2.txt", "Pal Calvari, amic")
    +  client.upload("#{path_prefix}/regular_file.txt", 'Che primo! aon vas?')
    +  client.upload("#{path_prefix}/regular_file_2.txt", 'Pal Calvari, amic')
     end
    @@ -753,15 +834,15 @@

     
     
    -62
    -63
    -64
    +70 +71 +72

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 62
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 70
     
     def build_create_file_request
    -  client.upload("#{path_prefix}/regular_file.txt", "Arkansas, dude.")
    +  client.upload("#{path_prefix}/regular_file.txt", 'Arkansas, dude.')
     end
    @@ -784,20 +865,20 @@

     
     
    -66
    -67
    -68
    -69
    -70
    -71
    -72
    -73
    +74 +75 +76 +77 +78 +79 +80 +81

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 66
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 74
     
     def build_delete
    -  file_contents = "Tijuana, amigo."
    +  file_contents = 'Tijuana, amigo.'
     
       client.upload "#{path_prefix}/will_be_deleted.txt", file_contents
       client.upload "#{path_prefix}/wont_be_deleted.txt", file_contents
    @@ -825,24 +906,24 @@ 

     
     
    -75
    -76
    -77
    -78
    -79
    -80
    -81
    -82
    +83 +84 +85 +86 +87 +88 +89 +90

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 75
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 83
     
     def 
    -  client.upload("#{path_prefix}/file.txt", "This is a test file.", {
    -    :client_modified => Time.new(1988, 12, 8, 1, 1, 0, "+00:00")
    +  client.upload("#{path_prefix}/file.txt", 'This is a test file.', {
    +    client_modified: Time.new(1988, 12, 8, 1, 1, 0, '+00:00')
       })
       client.create_folder("#{path_prefix}/folder")
    -  client.upload("#{path_prefix}/deleted_file.txt", "This is a test file.")
    +  client.upload("#{path_prefix}/deleted_file.txt", 'This is a test file.')
       client.delete("#{path_prefix}/deleted_file.txt")
     end
    @@ -866,22 +947,22 @@
    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 103
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 111
     
     def 
       client.create_folder("#{path_prefix}/shared_folder")
       client.create_shared_link_with_settings("#{path_prefix}/shared_folder")
     
    -  client.upload("#{path_prefix}/shared_file.txt", "I shall be shared.")
    +  client.upload("#{path_prefix}/shared_file.txt", 'I shall be shared.')
       client.create_shared_link_with_settings("#{path_prefix}/shared_file.txt")
     end
    @@ -905,16 +986,16 @@

     
     
    -98
    -99
    -100
    -101
    +106 +107 +108 +109

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 98
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 106
     
     def build_get_thumbnail_batch
    -  file_content = IO.read File.join(self.class.fixtures_path, "img.png")
    +  file_content = IO.read File.join(self.class.fixtures_path, 'img.png')
       client.upload("#{path_prefix}/img.png", file_content)
     end
    @@ -938,19 +1019,50 @@

     
     
    -84
    -85
    -86
    -87
    -88
    +92 +93 +94 +95 +96

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 84
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 92
     
     def build_list_folder
       client.create_folder("#{path_prefix}/shared_folder")
       client.create_shared_link_with_settings("#{path_prefix}/shared_folder")
    -  client.upload("#{path_prefix}/shared_folder/cow.txt", "Moo.")
    +  client.upload("#{path_prefix}/shared_folder/cow.txt", 'Moo.')
    +end
    + + + + + +
    +

    + + #build_searchObject + + + + + +

    + + + + @@ -973,12 +1085,12 @@

     
     
    -90
    -91
    -92
    +98 +99 +100

    +
    +
    +
    +119
    +120
    +121
    +
    +
    # File 'spec/support/dropbox_scaffold_builder.rb', line 119
    +
    +def build_search
    +  client.upload("#{path_prefix}/findable_file.txt", 'Moo.')
     end
    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 90
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 98
     
     def build_upload
       # No need to set up anything
    @@ -1004,12 +1116,12 @@ 

     
     
    -94
    -95
    -96
    +102 +103 +104

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 94
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 102
     
     def build_upload_by_chunks
       # No op
    @@ -1035,12 +1147,12 @@ 

     
     
    -53
    -54
    -55
    +61 +62 +63

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 53
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 61
     
     def client
       @client ||= DropboxApi::Client.new
    @@ -1066,14 +1178,14 @@ 

     
     
    -43
    -44
    -45
    -46
    -47
    +51 +52 +53 +54 +55

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 43
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 51
     
     def clobber
       client.delete path_prefix
    @@ -1101,12 +1213,12 @@ 

     
     
    -49
    -50
    -51
    +57 +58 +59

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 49
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 57
     
     def generate
       send "build_#{@endpoint_name}"
    @@ -1142,12 +1254,12 @@ 

     
     
    -112
    -113
    -114
    +124 +125 +126

    -
    # File 'spec/support/dropbox_scaffold_builder.rb', line 112
    +      
    # File 'spec/support/dropbox_scaffold_builder.rb', line 124
     
     def path_prefix
       File.join PREFIX, @endpoint_name
    @@ -1162,9 +1274,9 @@ 

    diff --git a/docs/_index.html b/docs/_index.html index 9b537341..87e5a92c 100644 --- a/docs/_index.html +++ b/docs/_index.html @@ -4,15 +4,15 @@ - Documentation by YARD 0.9.19 + Documentation by YARD 0.9.26 - + - + - @@ -52,7 +52,7 @@
    -

    Documentation by YARD 0.9.19

    +

    Documentation by YARD 0.9.26

    Alphabetic Index

    @@ -193,16 +193,16 @@

    Namespace Listing A-Z

  • - Base + Base - (DropboxApi::Metadata) + (DropboxApi::Results)
  • - Base + Base - (DropboxApi::Results) + (DropboxApi::Metadata)
  • @@ -597,6 +597,13 @@

    Namespace Listing A-Z

    +
  • + ExpiredAccessTokenError + + (DropboxApi::Errors) + +
  • + @@ -626,6 +633,20 @@

    Namespace Listing A-Z

    +
  • + FileCategoriesList + + (DropboxApi::Metadata) + +
  • + +
  • + FileCategory + + (DropboxApi::Metadata) + +
  • +
  • FileConflictError @@ -633,6 +654,13 @@

    Namespace Listing A-Z

  • +
  • + FileExtensionsList + + (DropboxApi::Metadata) + +
  • +
  • FileLinkMetadata @@ -661,6 +689,13 @@

    Namespace Listing A-Z

  • +
  • + FileStatus + + (DropboxApi::Metadata) + +
  • +
  • Files @@ -1264,6 +1299,13 @@

    Namespace Listing A-Z

  • +
  • + MetadataV2 + + (DropboxApi::Metadata) + +
  • +
  • MiddleWare @@ -1293,6 +1335,13 @@

    Namespace Listing A-Z

  • +
  • + NamespaceId + + (DropboxApi::Metadata) + +
  • +
  • NoAccountError @@ -1372,6 +1421,13 @@

    Namespace Listing A-Z

  • +
  • + PathRoot + + (DropboxApi::MiddleWare) + +
  • +
  • PermanentlyDelete @@ -1499,6 +1555,13 @@

    Namespace Listing A-Z

  • +
  • + RootInfo + + (DropboxApi::Metadata) + +
  • +
  • Rpc @@ -1580,6 +1643,13 @@

    Namespace Listing A-Z

  • +
  • + Search + + (DropboxApi::Results) + +
  • +
  • Search @@ -1588,9 +1658,9 @@

    Namespace Listing A-Z

  • - Search + SearchContinue - (DropboxApi::Results) + (DropboxApi::Endpoints::Files)
  • @@ -1602,7 +1672,42 @@

    Namespace Listing A-Z

  • - SearchResult + SearchMatchFieldOptions + + (DropboxApi::Metadata) + +
  • + +
  • + SearchMatchTypeV2 + + (DropboxApi::Metadata) + +
  • + +
  • + SearchMatchV2 + + (DropboxApi::Metadata) + +
  • + +
  • + SearchOptions + + (DropboxApi::Metadata) + +
  • + +
  • + SearchOrderBy + + (DropboxApi::Metadata) + +
  • + +
  • + SearchV2Result (DropboxApi::Results) @@ -1812,6 +1917,13 @@

    Namespace Listing A-Z

  • +
  • + TeamRootInfo + + (DropboxApi::Metadata) + +
  • +
  • ThumbnailBatchError @@ -2010,16 +2122,16 @@

    Namespace Listing A-Z

  • - UploadSessionStart + UploadSessionStart - (DropboxApi::Results) + (DropboxApi::Endpoints::Files)
  • - UploadSessionStart + UploadSessionStart - (DropboxApi::Endpoints::Files) + (DropboxApi::Results)
  • @@ -2030,6 +2142,13 @@

    Namespace Listing A-Z

    +
  • + UserRootInfo + + (DropboxApi::Metadata) + +
  • +
  • Users @@ -2100,9 +2219,9 @@

    Namespace Listing A-Z

  • diff --git a/docs/class_list.html b/docs/class_list.html index af2678bd..ebc8037e 100644 --- a/docs/class_list.html +++ b/docs/class_list.html @@ -4,9 +4,9 @@ - + - + @@ -43,7 +43,7 @@

    Class List

    diff --git a/docs/css/common.css b/docs/css/common.css index 3997a3a3..8c89606e 100644 --- a/docs/css/common.css +++ b/docs/css/common.css @@ -2,3 +2,6 @@ font-size: 13px; line-height: normal; } +.showSource { + font-size: 13px; +} diff --git a/docs/css/style.css b/docs/css/style.css index 0bf7e2c7..eb0dbc86 100644 --- a/docs/css/style.css +++ b/docs/css/style.css @@ -52,6 +52,7 @@ body { background: #fff; padding: 1.2em; padding-top: 0.2em; + box-sizing: border-box; } @media (max-width: 920px) { @@ -422,8 +423,8 @@ li.r2 { background: #fafafa; } #toc ol { padding-left: 1.8em; } #toc li { font-size: 1.1em; line-height: 1.7em; } #toc > ol > li { font-size: 1.1em; font-weight: bold; } -#toc ol > ol { font-size: 0.9em; } -#toc ol ol > ol { padding-left: 2.3em; } +#toc ol > li > ol { font-size: 0.9em; } +#toc ol ol > li > ol { padding-left: 2.3em; } #toc ol + li { margin-top: 0.3em; } #toc.hidden { padding: 10px; background: #fefefe; box-shadow: none; } #toc.hidden:hover { background: #fafafa; } diff --git a/docs/file.README.html b/docs/file.README.html index dae6acb0..a93b59d1 100644 --- a/docs/file.README.html +++ b/docs/file.README.html @@ -6,15 +6,15 @@ File: README - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -57,11 +57,11 @@
    -

    DropboxApi

    +

    DropboxApi

    Library for communicating with Dropbox API v2.

    -

    Installation

    +

    Installation

    Add this line to your application's Gemfile:

    @@ -78,7 +78,7 @@

    Installation

    $ gem install dropbox_api
     
    -

    Documentation

    +

    Documentation

    Please, refer to this gem's custom Dropbox API documentation. @@ -96,9 +96,9 @@

    Documentation

    use them. -

    Basic set up

    +

    Basic set up

    -

    Authorize your application

    +

    Authorize your application

    Dropbox uses OAuth, in order to use this library from your application you'll have to get an authorization code.

    @@ -116,43 +116,111 @@

    Authorize your application

    #=> #<DropboxApi::Client ...>

    -

    Note that setting an ENV variable is only a feasible choice if you're only -using one account.

    +

    The official documentation on the process to get an authorization code is +here, +it describes the two options listed below.

    -

    Option A: Get your access token from the website

    +

    Option A: Get your access token from the website

    -

    The easiest way to obtain an access token is to get it from the Dropbox website. -You just need to log in to Dropbox and refer to the developers section, go to -My apps and select your application, you may need to create one if you -haven't done so yet.

    +

    For a quick test, you can obtain an access token from the App Console in +Dropbox's website. Select from +My apps your application, you may need to create one if you +haven't done so yet. Under your application settings, find section +OAuth 2, there is a button to generate an access token.

    -

    Under your application settings, find section OAuth 2. You'll find a button -to generate an access token.

    +

    Option B: OAuth2 Code Flow

    -

    Option B: Use DropboxApi::Authenticator

    +

    This is typically what you will use in production, you can obtain an +authorization code with a 3-step process:

    -

    You can obtain an authorization code with this library:

    - -
    authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET)
    -authenticator.authorize_url #=> "https://www.dropbox.com/..."
    +
    # 1. Get an authorization URL.
    +authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET)
    +authenticator.auth_code.authorize_url #=> "https://www.dropbox.com/..."
     
    -# Now you need to open the authorization URL in your browser,
    -# authorize the application and copy your code.
    +# 2. Log into Dropbox and authorize your app. You need to open the
    +# authorization URL in your browser.
     
    -auth_bearer = authenticator.get_token(CODE) #=> #<OAuth2::AccessToken ...>`
    -auth_bearer.token #=> "VofXAX8D..."
    -# Keep this token, you'll need it to initialize a `DropboxApi::Client` object
    -
    +# 3. Exchange the authorization code for a reusable access token (not visible +# to the user). +access_token = authenticator.auth_code.get_token(CODE) #=> #<OAuth2::AccessToken ...>` +access_token.token #=> "VofXAX8D..." + +# Keep this token, you'll need it to initialize a `DropboxApi::Client` object: +client = DropboxApi::Client.new(access_token: access_token) -

    Standard OAuth 2 flow

    +# For backwards compatibility, the following also works: +client = DropboxApi::Client.new(access_token.token) +
    -

    This is what many web applications will use. The process is described in -Dropbox's OAuth guide.

    +
    Integration with Rails

    If you have a Rails application, you might be interested in this setup guide.

    -

    Performing API calls

    +
    Using refresh tokens
    + +

    Access tokens are short-lived by default (as of September 30th, 2021), +applications that require long-lived access to the API without additional +interaction with the user should use refresh tokens.

    + +

    The process is similar but a token refresh might seamlessly occur as you +perform API calls. When this happens you'll need to store the +new token hash if you want to continue using this session, you can use the +on_token_refreshed callback to do this.

    + +
    # 1. Get an authorization URL, requesting offline access type.
    +authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET)
    +authenticator.auth_code.authorize_url(token_access_type: 'offline')
    +
    +# 2. Log into Dropbox and authorize your app. You need to open the
    +#    authorization URL in your browser.
    +
    +# 3. Exchange the authorization code for a reusable access token
    +access_token = authenticator.auth_code.get_token(CODE) #=> #<OAuth2::AccessToken ...>`
    +
    +# You can now use the access token to initialize a DropboxApi::Client, you
    +# should also provide a callback function to store the updated access token
    +# whenever it's refreshed.
    +client = DropboxApi::Client.new(
    +  access_token: access_token,
    +  on_token_refreshed: lambda { |new_token_hash|
    +    # token_hash is a serializable Hash, something like this:
    +    # {
    +    #   "uid"=>"440",
    +    #   "token_type"=>"bearer",
    +    #   "scope"=>"account_info.read account_info.write...",
    +    #   "account_id"=>"dbid:AABOLtA1rT6rRK4vajKZ...",
    +    #   :access_token=>"sl.A5Ez_CBsqJILhDawHlmXSoZEhLZ4nuLFVRs6AJ...",
    +    #   :refresh_token=>"iMg4Me_oKYUAAAAAAAAAAapQixCgwfXOxuubCuK_...",
    +    #   :expires_at=>1632948328
    +    # }
    +    SomewhereSafe.save(new_token_hash)
    +  }
    +)
    +
    + +

    Once you've gone through the process above, you can skip the steps that require +user interaction in subsequent initializations of DropboxApi::Client. For +example:

    + +
    # 1. Initialize an authenticator
    +authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET)
    +
    +# 2. Retrieve the token hash you previously stored somewhere safe, you can use
    +#    it to build a new access token.
    +access_token = OAuth2::AccessToken.from_hash(authenticator, token_hash)
    +
    +# 3. You now have an access token, so you can initialize a client like you
    +#    would normally:
    +client = DropboxApi::Client.new(
    +  access_token: access_token,
    +  on_token_refreshed: lambda { |new_token_hash|
    +    SomewhereSafe.save(new_token_hash)
    +  }
    +)
    +
    + +

    Performing API calls

    Once you've initialized a client, for example:

    @@ -174,7 +242,7 @@

    Performing API calls

    perform API calls. You can check the class' documentation to find all available endpoints.

    -

    Large file uploads

    +

    Large file uploads

    If you need to upload files larger than 150MB the default #upload endpoint won't work. Instead, you need to start a upload session and upload @@ -194,21 +262,39 @@

    Large file uploads

    method documentation to find out all available options.

    -

    Dependencies

    +

    Accessing Team Folders

    + +

    In order to access your team scope you need to add the namespace_id to you request headers. +This can be done using the middlewere layer as per the below:

    + +
    client = DropboxApi::Client.new("VofXAX8D...")
    +#=> #<DropboxApi::Client ...>
    +client.namespace_id = client..root_info.root_namespace_id
    +
    +client.list_folder('')
    +#=> Now returns the team folders
    +
    + +

    You could unset the namespace ID at any point afterwards with just:

    + +
    client.namespace_id = nil
    +
    + +

    Dependencies

    This gem depends on oauth2 and faraday.

    -

    It has official support for Ruby versions 1.9.x and 2.x.

    +

    It has official support for Ruby versions 2.x.

    -

    Development

    +

    Development

    After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

    -

    Testing

    +

    Testing

    I recommend you to use a test account other than your main one.

    @@ -224,7 +310,12 @@

    Testing

    the DropboxScaffoldBuilder class to find all existing scaffold builders.

    DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rake test:build_scaffold[list_folder]
    -
    +
    + +

    Note that you'll have to type rake test:build_scaffold\[list_folder\] +if you use zsh.

    + +

    You can build all available scaffolds with just rake test:build_scaffold.

  • Run the tests and the cassettes will be written:

    DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rspec spec/endpoints/files/list_folder_spec.rb
    @@ -235,11 +326,11 @@ 

    Testing

    been filtered. However, you may want to double check before pushing your updates to Github.

    -

    Tip: You can simply run export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER at +

    Tip: you can simply run export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER at the beginning of your work session so you don't need to prefix it in every command line.

    -

    Contributing

    +

    Contributing

    Any help will be much appreciated. The easiest way to help is to implement one or more of the endpoints that are still pending. To see how the @@ -247,9 +338,9 @@

    Contributing

    diff --git a/docs/file.api_coverage.html b/docs/file.api_coverage.html index 6f2cb534..a17880cc 100644 --- a/docs/file.api_coverage.html +++ b/docs/file.api_coverage.html @@ -6,15 +6,15 @@ File: API Implementation Coverage - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -65,7 +65,7 @@ of the endpoint has been implemented but some options may be missing. Guess what new moon means.

    -

    File properties

    +

    File properties

    @@ -119,7 +119,7 @@

    File properties

    -

    File requests

    +

    File requests

    @@ -145,7 +145,7 @@

    File requests

    -

    Files

    +

    Files

    @@ -278,7 +278,7 @@

    Files

    - + @@ -311,7 +311,7 @@

    Files

    🌕
    /search/search_v2 🌔
    -

    Paper

    +

    Paper

    @@ -385,7 +385,7 @@

    Paper

    -

    Sharing

    +

    Sharing

    @@ -551,7 +551,7 @@

    Sharing

    -

    Users

    +

    Users

    @@ -577,7 +577,7 @@

    Users

    -

    Dropbox Business API

    +

    Dropbox Business API

    Unfortunately, none of the Dropbox Business endpoints have been implemented. If this is a problem for you, please open an @@ -585,9 +585,9 @@

    Dropbox Business API

    diff --git a/docs/file.rails_setup.html b/docs/file.rails_setup.html index 8b6e8115..7d889837 100644 --- a/docs/file.rails_setup.html +++ b/docs/file.rails_setup.html @@ -6,15 +6,15 @@ File: Rails setup - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -57,7 +57,7 @@
    -

    Standard OAuth 2 flow set up

    +

    Standard OAuth 2 flow set up

    This document describes how to implement the OAuth2 flow in a Rails application, the process is represented in the following diagram:

    @@ -66,7 +66,7 @@

    Source: https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web

    -

    1. Set up some new routes

    +

    1. Set up some new routes

    You'll have to create a couple of new routes:

    @@ -80,7 +80,7 @@

    1. Set up some new routes

    The other route, dropbox/auth_callback, will process the authentication token that we'll receive from Dropbox. Steps 4 & 5.

    -

    2. Set up a Dropbox controller

    +

    2. Set up a Dropbox controller

    class DropboxController < ApplicationController
       # Example call:
    @@ -121,7 +121,7 @@ 

    2. Set up a Dropbox controller

    end
    -

    3. Set up redirect URI in your Dropbox app settings

    +

    3. Set up redirect URI in your Dropbox app settings

    In the previous code, you probably noticed that we're providing a redirect_uri parameter. This is where the user will be redirected to after accepting our @@ -142,9 +142,9 @@

    3. Set up redirect URI in your Dropbox app settings

    diff --git a/docs/file_list.html b/docs/file_list.html index dd04a55b..8e858d55 100644 --- a/docs/file_list.html +++ b/docs/file_list.html @@ -4,9 +4,9 @@ - + - + diff --git a/docs/frames.html b/docs/frames.html index 2caef9d0..1310783d 100644 --- a/docs/frames.html +++ b/docs/frames.html @@ -2,9 +2,9 @@ - Documentation by YARD 0.9.19 + Documentation by YARD 0.9.26 - @@ -57,11 +57,11 @@
    -

    DropboxApi

    +

    DropboxApi

    Library for communicating with Dropbox API v2.

    -

    Installation

    +

    Installation

    Add this line to your application's Gemfile:

    @@ -78,7 +78,7 @@

    Installation

    $ gem install dropbox_api
     
    -

    Documentation

    +

    Documentation

    Please, refer to this gem's custom Dropbox API documentation. @@ -96,9 +96,9 @@

    Documentation

    use them.
  • -

    Basic set up

    +

    Basic set up

    -

    Authorize your application

    +

    Authorize your application

    Dropbox uses OAuth, in order to use this library from your application you'll have to get an authorization code.

    @@ -116,43 +116,111 @@

    Authorize your application

    #=> #<DropboxApi::Client ...>
    -

    Note that setting an ENV variable is only a feasible choice if you're only -using one account.

    +

    The official documentation on the process to get an authorization code is +here, +it describes the two options listed below.

    -

    Option A: Get your access token from the website

    +

    Option A: Get your access token from the website

    -

    The easiest way to obtain an access token is to get it from the Dropbox website. -You just need to log in to Dropbox and refer to the developers section, go to -My apps and select your application, you may need to create one if you -haven't done so yet.

    +

    For a quick test, you can obtain an access token from the App Console in +Dropbox's website. Select from +My apps your application, you may need to create one if you +haven't done so yet. Under your application settings, find section +OAuth 2, there is a button to generate an access token.

    -

    Under your application settings, find section OAuth 2. You'll find a button -to generate an access token.

    +

    Option B: OAuth2 Code Flow

    -

    Option B: Use DropboxApi::Authenticator

    +

    This is typically what you will use in production, you can obtain an +authorization code with a 3-step process:

    -

    You can obtain an authorization code with this library:

    - -
    authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET)
    -authenticator.authorize_url #=> "https://www.dropbox.com/..."
    +
    # 1. Get an authorization URL.
    +authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET)
    +authenticator.auth_code.authorize_url #=> "https://www.dropbox.com/..."
     
    -# Now you need to open the authorization URL in your browser,
    -# authorize the application and copy your code.
    +# 2. Log into Dropbox and authorize your app. You need to open the
    +# authorization URL in your browser.
     
    -auth_bearer = authenticator.get_token(CODE) #=> #<OAuth2::AccessToken ...>`
    -auth_bearer.token #=> "VofXAX8D..."
    -# Keep this token, you'll need it to initialize a `DropboxApi::Client` object
    -
    +# 3. Exchange the authorization code for a reusable access token (not visible +# to the user). +access_token = authenticator.auth_code.get_token(CODE) #=> #<OAuth2::AccessToken ...>` +access_token.token #=> "VofXAX8D..." + +# Keep this token, you'll need it to initialize a `DropboxApi::Client` object: +client = DropboxApi::Client.new(access_token: access_token) -

    Standard OAuth 2 flow

    +# For backwards compatibility, the following also works: +client = DropboxApi::Client.new(access_token.token) +
    -

    This is what many web applications will use. The process is described in -Dropbox's OAuth guide.

    +
    Integration with Rails

    If you have a Rails application, you might be interested in this setup guide.

    -

    Performing API calls

    +
    Using refresh tokens
    + +

    Access tokens are short-lived by default (as of September 30th, 2021), +applications that require long-lived access to the API without additional +interaction with the user should use refresh tokens.

    + +

    The process is similar but a token refresh might seamlessly occur as you +perform API calls. When this happens you'll need to store the +new token hash if you want to continue using this session, you can use the +on_token_refreshed callback to do this.

    + +
    # 1. Get an authorization URL, requesting offline access type.
    +authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET)
    +authenticator.auth_code.authorize_url(token_access_type: 'offline')
    +
    +# 2. Log into Dropbox and authorize your app. You need to open the
    +#    authorization URL in your browser.
    +
    +# 3. Exchange the authorization code for a reusable access token
    +access_token = authenticator.auth_code.get_token(CODE) #=> #<OAuth2::AccessToken ...>`
    +
    +# You can now use the access token to initialize a DropboxApi::Client, you
    +# should also provide a callback function to store the updated access token
    +# whenever it's refreshed.
    +client = DropboxApi::Client.new(
    +  access_token: access_token,
    +  on_token_refreshed: lambda { |new_token_hash|
    +    # token_hash is a serializable Hash, something like this:
    +    # {
    +    #   "uid"=>"440",
    +    #   "token_type"=>"bearer",
    +    #   "scope"=>"account_info.read account_info.write...",
    +    #   "account_id"=>"dbid:AABOLtA1rT6rRK4vajKZ...",
    +    #   :access_token=>"sl.A5Ez_CBsqJILhDawHlmXSoZEhLZ4nuLFVRs6AJ...",
    +    #   :refresh_token=>"iMg4Me_oKYUAAAAAAAAAAapQixCgwfXOxuubCuK_...",
    +    #   :expires_at=>1632948328
    +    # }
    +    SomewhereSafe.save(new_token_hash)
    +  }
    +)
    +
    + +

    Once you've gone through the process above, you can skip the steps that require +user interaction in subsequent initializations of DropboxApi::Client. For +example:

    + +
    # 1. Initialize an authenticator
    +authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET)
    +
    +# 2. Retrieve the token hash you previously stored somewhere safe, you can use
    +#    it to build a new access token.
    +access_token = OAuth2::AccessToken.from_hash(authenticator, token_hash)
    +
    +# 3. You now have an access token, so you can initialize a client like you
    +#    would normally:
    +client = DropboxApi::Client.new(
    +  access_token: access_token,
    +  on_token_refreshed: lambda { |new_token_hash|
    +    SomewhereSafe.save(new_token_hash)
    +  }
    +)
    +
    + +

    Performing API calls

    Once you've initialized a client, for example:

    @@ -174,7 +242,7 @@

    Performing API calls

    perform API calls. You can check the class' documentation to find all available endpoints.

    -

    Large file uploads

    +

    Large file uploads

    If you need to upload files larger than 150MB the default #upload endpoint won't work. Instead, you need to start a upload session and upload @@ -194,21 +262,39 @@

    Large file uploads

    method documentation to find out all available options.

    -

    Dependencies

    +

    Accessing Team Folders

    + +

    In order to access your team scope you need to add the namespace_id to you request headers. +This can be done using the middlewere layer as per the below:

    + +
    client = DropboxApi::Client.new("VofXAX8D...")
    +#=> #<DropboxApi::Client ...>
    +client.namespace_id = client..root_info.root_namespace_id
    +
    +client.list_folder('')
    +#=> Now returns the team folders
    +
    + +

    You could unset the namespace ID at any point afterwards with just:

    + +
    client.namespace_id = nil
    +
    + +

    Dependencies

    This gem depends on oauth2 and faraday.

    -

    It has official support for Ruby versions 1.9.x and 2.x.

    +

    It has official support for Ruby versions 2.x.

    -

    Development

    +

    Development

    After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

    -

    Testing

    +

    Testing

    I recommend you to use a test account other than your main one.

    @@ -224,7 +310,12 @@

    Testing

    the DropboxScaffoldBuilder class to find all existing scaffold builders.

    DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rake test:build_scaffold[list_folder]
    -
    + + +

    Note that you'll have to type rake test:build_scaffold\[list_folder\] +if you use zsh.

    + +

    You can build all available scaffolds with just rake test:build_scaffold.

  • Run the tests and the cassettes will be written:

    DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER rspec spec/endpoints/files/list_folder_spec.rb
    @@ -235,11 +326,11 @@ 

    Testing

    been filtered. However, you may want to double check before pushing your updates to Github.

    -

    Tip: You can simply run export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER at +

    Tip: you can simply run export DROPBOX_OAUTH_BEARER=YOUR_AUTH_BEARER at the beginning of your work session so you don't need to prefix it in every command line.

    -

    Contributing

    +

    Contributing

    Any help will be much appreciated. The easiest way to help is to implement one or more of the endpoints that are still pending. To see how the @@ -247,9 +338,9 @@

    Contributing

    diff --git a/docs/js/app.js b/docs/js/app.js index 368f44a9..8d067fe3 100644 --- a/docs/js/app.js +++ b/docs/js/app.js @@ -171,6 +171,7 @@ function generateTOC() { var counter = 0; var tags = ['h2', 'h3', 'h4', 'h5', 'h6']; var i; + var curli; if ($('#filecontents h1').length > 1) tags.unshift('h1'); for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; } var lastTag = parseInt(tags[0][1], 10); @@ -190,15 +191,25 @@ function generateTOC() { } if (thisTag > lastTag) { for (i = 0; i < thisTag - lastTag; i++) { - var tmp = $('
      '); toc.append(tmp); toc = tmp; + if ( typeof(curli) == "undefined" ) { + curli = $('
    1. '); + toc.append(curli); + } + toc = $('
        '); + curli.append(toc); + curli = undefined; } } if (thisTag < lastTag) { - for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent(); + for (i = 0; i < lastTag - thisTag; i++) { + toc = toc.parent(); + toc = toc.parent(); + } } var title = $(this).attr('toc-title'); if (typeof(title) == "undefined") title = $(this).text(); - toc.append('
      1. ' + title + '
      2. '); + curli =$('
      3. ' + title + '
      4. '); + toc.append(curli); lastTag = thisTag; }); if (!show) return; diff --git a/docs/method_list.html b/docs/method_list.html index 5d2363e7..3377b84b 100644 --- a/docs/method_list.html +++ b/docs/method_list.html @@ -4,9 +4,9 @@ - + - + @@ -62,32 +62,32 @@

        Method List

      5. - #add_file_member - DropboxApi::Client + #add_file_member + DropboxApi::Endpoints::Sharing::AddFileMember
      6. - #add_file_member - DropboxApi::Endpoints::Sharing::AddFileMember + #add_file_member + DropboxApi::Client
      7. - #add_folder_member - DropboxApi::Endpoints::Sharing::AddFolderMember + #add_folder_member + DropboxApi::Client
      8. - #add_folder_member - DropboxApi::Client + #add_folder_member + DropboxApi::Endpoints::Sharing::AddFolderMember
      9. @@ -124,6 +124,22 @@

        Method List

        +
      10. +
        + build + DropboxApi::Errors::TooManyRequestsError +
        +
      11. + + +
      12. +
        + build + DropboxApi::Errors::BasicError +
        +
      13. + +
      14. #build @@ -142,21 +158,45 @@

        Method List

      15. - build - DropboxApi::Errors::BasicError + #build_connection + DropboxApi::Endpoints::RpcNotify
      16. - build - DropboxApi::Errors::TooManyRequestsError + #build_connection + DropboxApi::Endpoints::ContentUpload +
        +
      17. + + +
      18. +
        + #build_connection + DropboxApi::Endpoints::RpcContent +
        +
      19. + + +
      20. +
        + #build_connection + DropboxApi::Endpoints::Rpc
      21. +
        + #build_connection + DropboxApi::Endpoints::ContentDownload +
        +
      22. + + +
      23. #build_copy_batch DropboxScaffoldBuilder @@ -164,7 +204,7 @@

        Method List

      24. -
      25. +
      26. #build_create_file_request DropboxScaffoldBuilder @@ -172,7 +212,7 @@

        Method List

      27. -
      28. +
      29. #build_delete DropboxScaffoldBuilder @@ -180,7 +220,7 @@

        Method List

      30. -
      31. +
      32. #build_entries_params DropboxApi::Endpoints::Files::GetThumbnailBatch @@ -188,7 +228,7 @@

        Method List

      33. -
      34. +
      35. #build_error DropboxApi::ResultBuilder @@ -196,7 +236,7 @@

        Method List

      36. -
      37. +
      38. build_from_options DropboxApi::Metadata::CommitInfo @@ -204,7 +244,7 @@

        Method List

      39. -
      40. +
      41. build_from_string DropboxApi::Metadata::AddMember @@ -212,7 +252,7 @@

        Method List

      42. -
      43. +
      44. #build_get_metadata DropboxScaffoldBuilder @@ -220,7 +260,7 @@

        Method List

      45. -
      46. +
      47. #build_get_shared_link_metadata DropboxScaffoldBuilder @@ -228,7 +268,7 @@

        Method List

      48. -
      49. +
      50. #build_get_thumbnail_batch DropboxScaffoldBuilder @@ -236,7 +276,7 @@

        Method List

      51. -
      52. +
      53. #build_list_folder DropboxScaffoldBuilder @@ -244,26 +284,34 @@

        Method List

      54. +
      55. +
        + #build_request + DropboxApi::Endpoints::ContentDownload +
        +
      56. + +
      57. - #build_request - DropboxApi::Endpoints::Rpc + #build_request + DropboxApi::Endpoints::ContentUpload
      58. - #build_request - DropboxApi::Endpoints::ContentDownload + #build_request + DropboxApi::Endpoints::Rpc
      59. - #build_request - DropboxApi::Endpoints::ContentUpload + #build_search + DropboxScaffoldBuilder
      60. @@ -285,6 +333,14 @@

        Method List

      61. +
        + #call + DropboxApi::MiddleWare::PathRoot +
        +
      62. + + +
      63. #call DropboxApi::MiddleWare::DecodeResult @@ -292,6 +348,14 @@

        Method List

      64. +
      65. +
        + #can_refresh_access_token? + DropboxApi::ConnectionBuilder +
        +
      66. + +
      67. #cast @@ -374,16 +438,16 @@

        Method List

      68. - #copy_batch_check - DropboxApi::Client + #copy_batch_check + DropboxApi::Endpoints::Files::CopyBatchCheck
      69. - #copy_batch_check - DropboxApi::Endpoints::Files::CopyBatchCheck + #copy_batch_check + DropboxApi::Client
      70. @@ -398,32 +462,32 @@

        Method List

      71. - #copy_reference_get - DropboxApi::Endpoints::Files::CopyReferenceGet + #copy_reference_get + DropboxApi::Client
      72. - #copy_reference_get - DropboxApi::Client + #copy_reference_get + DropboxApi::Endpoints::Files::CopyReferenceGet
      73. - #copy_reference_save - DropboxApi::Client + #copy_reference_save + DropboxApi::Endpoints::Files::CopyReferenceSave
      74. - #copy_reference_save - DropboxApi::Endpoints::Files::CopyReferenceSave + #copy_reference_save + DropboxApi::Client
      75. @@ -446,16 +510,16 @@

        Method List

      76. - #create_folder - DropboxApi::Client + #create_folder + DropboxApi::Endpoints::Files::CreateFolder
      77. - #create_folder - DropboxApi::Endpoints::Files::CreateFolder + #create_folder + DropboxApi::Client
      78. @@ -478,16 +542,16 @@

        Method List

      79. - #create_folder_batch_check - DropboxApi::Endpoints::Files::CreateFolderBatchCheck + #create_folder_batch_check + DropboxApi::Client
      80. - #create_folder_batch_check - DropboxApi::Client + #create_folder_batch_check + DropboxApi::Endpoints::Files::CreateFolderBatchCheck
      81. @@ -510,56 +574,56 @@

        Method List

      82. - #cursor - DropboxApi::Results::ListSharedLinksResult + #cursor + DropboxApi::Results::SharedFileMembers
      83. - #cursor - DropboxApi::Results::ListFolderResult + #cursor + DropboxApi::Results::SearchV2Result
      84. - #cursor - DropboxApi::Results::SharedFileMembers + #cursor + DropboxApi::Results::ListSharedLinksResult
      85. - #cursor - DropboxApi::Results::SharedFolderMembers + #cursor + DropboxApi::Results::ListFolderGetLatestCursorResult
      86. - #cursor - DropboxApi::Results::ListFolderGetLatestCursorResult + #cursor + DropboxApi::Results::SharedFolderMembers
      87. - #decode - DropboxApi::MiddleWare::DecodeResult + #cursor + DropboxApi::Results::ListFolderResult
      88. - #delete - DropboxApi::Client + #decode + DropboxApi::MiddleWare::DecodeResult
      89. @@ -574,7 +638,7 @@

        Method List

      90. - #delete_batch + #delete DropboxApi::Client
      91. @@ -590,7 +654,7 @@

        Method List

      92. - #delete_batch_check + #delete_batch DropboxApi::Client
      93. @@ -605,6 +669,14 @@

        Method List

      94. +
        + #delete_batch_check + DropboxApi::Client +
        +
      95. + + +
      96. #download DropboxApi::Endpoints::Files::Download @@ -612,7 +684,7 @@

        Method List

      97. -
      98. +
      99. #download DropboxApi::Client @@ -620,6 +692,14 @@

        Method List

      100. +
      101. +
        + #entries + DropboxApi::Results::GetThumbnailBatchResult +
        +
      102. + +
      103. #entries @@ -637,14 +717,6 @@

        Method List

      104. -
        - #entries - DropboxApi::Results::GetThumbnailBatchResult -
        -
      105. - - -
      106. #error DropboxApi::ResultBuilder @@ -652,7 +724,7 @@

        Method List

      107. -
      108. +
      109. #error_summary DropboxApi::ResultBuilder @@ -660,7 +732,7 @@

        Method List

      110. -
      111. +
      112. #expires DropboxApi::Results::GetCopyReferenceResult @@ -668,7 +740,7 @@

        Method List

      113. -
      114. +
      115. field DropboxApi::Metadata::Base @@ -676,7 +748,7 @@

        Method List

      116. -
      117. +
      118. fields DropboxApi::Metadata::Base @@ -684,7 +756,7 @@

        Method List

      119. -
      120. +
      121. #file DropboxApi::Results::GetTemporaryLinkResult @@ -692,7 +764,7 @@

        Method List

      122. -
      123. +
      124. find_subtype DropboxApi::Errors::BasicError @@ -700,7 +772,7 @@

        Method List

      125. -
      126. +
      127. #finish DropboxApi::ChunkedUploader @@ -708,7 +780,7 @@

        Method List

      128. -
      129. +
      130. fixtures_path DropboxScaffoldBuilder @@ -716,7 +788,7 @@

        Method List

      131. -
      132. +
      133. #force_cast DropboxApi::Metadata::Field @@ -724,7 +796,7 @@

        Method List

      134. -
      135. +
      136. #generate DropboxScaffoldBuilder @@ -732,6 +804,14 @@

        Method List

      137. +
      138. +
        + #get_account + DropboxApi::Endpoints::Users::GetAccount +
        +
      139. + +
      140. #get_account @@ -742,23 +822,23 @@

        Method List

      141. - #get_account - DropboxApi::Endpoints::Users::GetAccount + #get_account_batch + DropboxApi::Endpoints::Users::GetAccountBatch
      142. - #get_account_batch - DropboxApi::Endpoints::Users::GetAccountBatch + #get_account_batch + DropboxApi::Client
      143. - #get_account_batch + #get_current_account DropboxApi::Client
      144. @@ -773,14 +853,6 @@

        Method List

      145. -
        - #get_current_account - DropboxApi::Client -
        -
      146. - - -
      147. #get_metadata DropboxApi::Endpoints::Files::GetMetadata @@ -788,7 +860,7 @@

        Method List

      148. -
      149. +
      150. #get_metadata DropboxApi::Client @@ -796,14 +868,6 @@

        Method List

      151. -
      152. -
        - #get_preview - DropboxApi::Client -
        -
      153. - -
      154. #get_preview @@ -814,7 +878,7 @@

        Method List

      155. - #get_shared_link_metadata + #get_preview DropboxApi::Client
      156. @@ -830,8 +894,8 @@

        Method List

      157. - #get_space_usage - DropboxApi::Endpoints::Users::GetSpaceUsage + #get_shared_link_metadata + DropboxApi::Client
      158. @@ -846,8 +910,8 @@

        Method List

      159. - #get_temporary_link - DropboxApi::Endpoints::Files::GetTemporaryLink + #get_space_usage + DropboxApi::Endpoints::Users::GetSpaceUsage
      160. @@ -862,8 +926,8 @@

        Method List

      161. - #get_thumbnail - DropboxApi::Endpoints::Files::GetThumbnail + #get_temporary_link + DropboxApi::Endpoints::Files::GetTemporaryLink
      162. @@ -878,176 +942,176 @@

        Method List

      163. - #get_thumbnail_batch - DropboxApi::Endpoints::Files::GetThumbnailBatch + #get_thumbnail + DropboxApi::Endpoints::Files::GetThumbnail
      164. - #get_thumbnail_batch - DropboxApi::Client + #get_thumbnail_batch + DropboxApi::Endpoints::Files::GetThumbnailBatch
      165. - #groups - DropboxApi::Results::SharedFileMembers + #get_thumbnail_batch + DropboxApi::Client
      166. - #groups - DropboxApi::Results::SharedFolderMembers + #groups + DropboxApi::Results::SharedFileMembers
      167. - #has_error? - DropboxApi::ResultBuilder + #groups + DropboxApi::Results::SharedFolderMembers
      168. - #has_more? - DropboxApi::Results::ListFolderResult + #has_error? + DropboxApi::ResultBuilder
      169. - #has_more? - DropboxApi::Results::ListSharedLinksResult + #has_more? + DropboxApi::Results::SearchV2Result
      170. - #has_more? - DropboxApi::Results::SearchResult + #has_more? + DropboxApi::Results::ListFolderResult
      171. - #initialize - DropboxApi::Metadata::WriteMode + #has_more? + DropboxApi::Results::ListSharedLinksResult
      172. - #initialize - DropboxApi::Results::Search::Match + #initialize + DropboxApi::Errors::UploadSessionOffsetError
      173. - #initialize - DropboxApi::Results::Base + #initialize + DropboxApi::MiddleWare::Stack
      174. - #initialize - DropboxApi::Authenticator + #initialize + DropboxApi::Metadata::MemberActionList
      175. - #initialize - DropboxApi::Endpoints::Rpc + #initialize + DropboxApi::Results::BasicAccountBatch
      176. - #initialize - DropboxApi::Metadata::SharedLink + #initialize + DropboxScaffoldBuilder
      177. - #initialize - DropboxApi::Endpoints::ContentUpload + #initialize + DropboxApi::Metadata::MemberPermissionList
      178. - #initialize - DropboxApi::Endpoints::RpcNotify + #initialize + DropboxApi::Errors::BasicError
      179. - #initialize - DropboxApi::Metadata::Base + #initialize + DropboxApi::Metadata::WriteMode
      180. - #initialize - DropboxApi::Endpoints::ContentDownload + #initialize + DropboxApi::Metadata::SharedLink
      181. - #initialize - DropboxScaffoldBuilder + #initialize + DropboxApi::Client
      182. - #initialize - DropboxApi::Metadata::MemberActionList + #initialize + DropboxApi::ChunkedUploader
      183. - #initialize - DropboxApi::Results::BasicAccountBatch + #initialize + DropboxApi::Metadata::Member
      184. - #initialize - DropboxApi::Metadata::Field + #initialize + DropboxApi::Results::AddFileMemberResultList
      185. @@ -1062,80 +1126,80 @@

        Method List

      186. - #initialize - DropboxApi::Errors::BasicError + #initialize + DropboxApi::Metadata::Field
      187. - #initialize - DropboxApi::Metadata::MemberPermissionList + #initialize + DropboxApi::Endpoints::Base
      188. - #initialize - DropboxApi::ConnectionBuilder + #initialize + DropboxApi::Metadata::Base
      189. - #initialize - DropboxApi::Client + #initialize + DropboxApi::Authenticator
      190. - #initialize - DropboxApi::Endpoints::RpcContent + #initialize + DropboxApi::MiddleWare::PathRoot
      191. - #initialize - DropboxApi::MiddleWare::Stack + #initialize + DropboxApi::Results::Search::Match
      192. - #initialize - DropboxApi::Errors::UploadSessionOffsetError + #initialize + DropboxApi::Metadata::FileCategoriesList
      193. - #initialize - DropboxApi::ChunkedUploader + #initialize + DropboxApi::Metadata::FileExtensionsList
      194. - #initialize - DropboxApi::Metadata::Member + #initialize + DropboxApi::Results::Base
      195. - #initialize - DropboxApi::Results::AddFileMemberResultList + #initialize + DropboxApi::ConnectionBuilder
      196. @@ -1246,16 +1310,16 @@

        Method List

      197. - #list_folder_longpoll - DropboxApi::Endpoints::Files::ListFolderLongpoll + #list_folder_longpoll + DropboxApi::Client
      198. - #list_folder_longpoll - DropboxApi::Client + #list_folder_longpoll + DropboxApi::Endpoints::Files::ListFolderLongpoll
      199. @@ -1318,13 +1382,21 @@

        Method List

      200. - #matches - DropboxApi::Results::SearchResult + #matches + DropboxApi::Results::SearchV2Result
      201. +
        + #middleware + DropboxApi::Client +
        +
      202. + + +
      203. #middleware DropboxApi::ConnectionBuilder @@ -1332,15 +1404,15 @@

        Method List

      204. -
      205. +
      206. - #middleware + #move DropboxApi::Client
      207. -
      208. +
      209. #move DropboxApi::Endpoints::Files::Move @@ -1348,9 +1420,17 @@

        Method List

      210. +
      211. +
        + #namespace_id + DropboxApi::ConnectionBuilder +
        +
      212. + +
      213. - #move + #namespace_id DropboxApi::Client
      214. @@ -1358,72 +1438,104 @@

        Method List

      215. - new - DropboxApi::Metadata::Resource + #namespace_id + DropboxApi::MiddleWare::PathRoot
      216. - new - DropboxApi::Results::CreateFolderBatchResultEntry + #namespace_id= + DropboxApi::Client
      217. - new - DropboxApi::Results::DeleteBatchResultEntry + #namespace_id_header_value + DropboxApi::MiddleWare::PathRoot
      218. - new - DropboxApi::Metadata::FileMemberAction + new + DropboxApi::Results::ShareFolderLaunch
      219. - new - DropboxApi::Results::CopyBatchResult + new + DropboxApi::Metadata::SharedLinkMetadata
      220. - new - DropboxApi::Results::RelocationBatchResultEntry + new + DropboxApi::Metadata::Tag
      221. - new - DropboxApi::Results::CreateFolderBatchResult + new + DropboxApi::Results::SaveUrlJobStatus
      222. - new - DropboxApi::Metadata::ThumbnailBatchResultEntry + new + DropboxApi::Results::RelocationBatchResult
      223. - new - DropboxApi::Results::RelocationBatchResult + new + DropboxApi::Results::DeleteBatchResult +
        +
      224. + + +
      225. +
        + new + DropboxApi::Metadata::FileMemberAction +
        +
      226. + + +
      227. +
        + new + DropboxApi::Metadata::Resource +
        +
      228. + + +
      229. +
        + new + DropboxApi::Results::DeleteBatchResultEntry +
        +
      230. + + +
      231. +
        + new + DropboxApi::Results::CopyBatchResult
      232. @@ -1438,48 +1550,48 @@

        Method List

      233. - new - DropboxApi::Metadata::SharedLinkMetadata + new + DropboxApi::Results::CreateFolderBatchResult
      234. - new - DropboxApi::Metadata::MediaInfo + new + DropboxApi::Metadata::RootInfo
      235. - new - DropboxApi::Results::DeleteBatchResult + new + DropboxApi::Metadata::MediaInfo
      236. - new - DropboxApi::Results::SaveUrlJobStatus + new + DropboxApi::Results::CreateFolderBatchResultEntry
      237. - new - DropboxApi::Metadata::Tag + new + DropboxApi::Results::RelocationBatchResultEntry
      238. - new - DropboxApi::Results::ShareFolderLaunch + new + DropboxApi::Metadata::ThumbnailBatchResultEntry
      239. @@ -1502,32 +1614,32 @@

        Method List

      240. - #perform_request - DropboxApi::Endpoints::ContentUpload + #perform_request + DropboxApi::Endpoints::ContentDownload
      241. - #perform_request - DropboxApi::Endpoints::ContentDownload + #perform_request + DropboxApi::Endpoints::ContentUpload
      242. - #permanently_delete - DropboxApi::Client + #permanently_delete + DropboxApi::Endpoints::Files::PermanentlyDelete
      243. - #permanently_delete - DropboxApi::Endpoints::Files::PermanentlyDelete + #permanently_delete + DropboxApi::Client
      244. @@ -1549,6 +1661,14 @@

        Method List

      245. +
        + #refresh_access_token + DropboxApi::ConnectionBuilder +
        +
      246. + + +
      247. regenerate DropboxScaffoldBuilder @@ -1556,6 +1676,14 @@

        Method List

      248. +
      249. +
        + regenerate_all + DropboxScaffoldBuilder +
        +
      250. + +
      251. #request_body @@ -1566,32 +1694,32 @@

        Method List

      252. - #resource - DropboxApi::Results::Search::Match + #resource + DropboxApi::Results::SaveCopyReferenceResult
      253. - #resource - DropboxApi::Results::GetCopyReferenceResult + #resource + DropboxApi::Results::Search::Match
      254. - #resource - DropboxApi::Results::SaveCopyReferenceResult + #resource + DropboxApi::Metadata::SearchMatchV2
      255. - #restore - DropboxApi::Client + #resource + DropboxApi::Results::GetCopyReferenceResult
      256. @@ -1605,6 +1733,14 @@

        Method List

      257. +
        + #restore + DropboxApi::Client +
        +
      258. + + +
      259. #retry_after DropboxApi::Errors::TooManyRequestsError @@ -1612,7 +1748,7 @@

        Method List

      260. -
      261. +
      262. #revoke_shared_link DropboxApi::Endpoints::Sharing::RevokeSharedLink @@ -1620,7 +1756,7 @@

        Method List

      263. -
      264. +
      265. #revoke_shared_link DropboxApi::Client @@ -1628,7 +1764,7 @@

        Method List

      266. -
      267. +
      268. #save_url DropboxApi::Client @@ -1636,7 +1772,7 @@

        Method List

      269. -
      270. +
      271. #save_url DropboxApi::Endpoints::Files::SaveUrl @@ -1644,7 +1780,7 @@

        Method List

      272. -
      273. +
      274. #save_url_check_job_status DropboxApi::Client @@ -1652,7 +1788,7 @@

        Method List

      275. -
      276. +
      277. #save_url_check_job_status DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus @@ -1660,6 +1796,14 @@

        Method List

      278. +
      279. +
        + #search + DropboxApi::Endpoints::Files::Search +
        +
      280. + +
      281. #search @@ -1670,32 +1814,32 @@

        Method List

      282. - #search - DropboxApi::Endpoints::Files::Search + #search_continue + DropboxApi::Endpoints::Files::SearchContinue
      283. - #serialized_field - DropboxApi::Metadata::Base + #search_continue + DropboxApi::Client
      284. - #session_id - DropboxApi::Results::UploadSessionStart + #serialized_field + DropboxApi::Metadata::Base
      285. - #share_folder - DropboxApi::Endpoints::Sharing::ShareFolder + #session_id + DropboxApi::Results::UploadSessionStart
      286. @@ -1710,24 +1854,24 @@

        Method List

      287. - #shared_folder - DropboxApi::Errors::AlreadySharedError + #share_folder + DropboxApi::Endpoints::Sharing::ShareFolder
      288. - #start - DropboxApi::ChunkedUploader + #shared_folder + DropboxApi::Errors::AlreadySharedError
      289. - #start - DropboxApi::Results::SearchResult + #start + DropboxApi::ChunkedUploader
      290. @@ -1742,56 +1886,56 @@

        Method List

      291. - #to_hash - DropboxApi::Metadata::File + #to_hash + DropboxApi::Metadata::Folder
      292. - #to_hash - DropboxApi::Metadata::Base + #to_hash + DropboxApi::Metadata::SharedLink
      293. - #to_hash - DropboxApi::Metadata::WriteMode + #to_hash + DropboxApi::Metadata::NamespaceId
      294. - #to_hash - DropboxApi::Metadata::Folder + #to_hash + DropboxApi::Metadata::WriteMode
      295. - #to_hash - DropboxApi::Metadata::SharedLink + #to_hash + DropboxApi::Metadata::Base
      296. - #to_hash - DropboxApi::Metadata::Member + #to_hash + DropboxApi::Metadata::File
      297. - #token_revoke - DropboxApi::Client + #to_hash + DropboxApi::Metadata::Member
      298. @@ -1806,8 +1950,8 @@

        Method List

      299. - #unshare_file - DropboxApi::Endpoints::Sharing::UnshareFile + #token_revoke + DropboxApi::Client
      300. @@ -1822,8 +1966,8 @@

        Method List

      301. - #upload - DropboxApi::Endpoints::Files::Upload + #unshare_file + DropboxApi::Endpoints::Sharing::UnshareFile
      302. @@ -1845,6 +1989,14 @@

        Method List

      303. +
        + #upload + DropboxApi::Endpoints::Files::Upload +
        +
      304. + + +
      305. #upload_by_chunks DropboxApi::Client @@ -1852,7 +2004,7 @@

        Method List

      306. -
      307. +
      308. #upload_session_append_v2 DropboxApi::Endpoints::Files::UploadSessionAppendV2 @@ -1860,7 +2012,7 @@

        Method List

      309. -
      310. +
      311. #upload_session_append_v2 DropboxApi::Client @@ -1868,7 +2020,7 @@

        Method List

      312. -
      313. +
      314. #upload_session_finish DropboxApi::Client @@ -1876,7 +2028,7 @@

        Method List

      315. -
      316. +
      317. #upload_session_finish DropboxApi::Endpoints::Files::UploadSessionFinish @@ -1884,6 +2036,14 @@

        Method List

      318. +
      319. +
        + #upload_session_start + DropboxApi::Endpoints::Files::UploadSessionStart +
        +
      320. + +
      321. #upload_session_start @@ -1894,37 +2054,45 @@

        Method List

      322. - #upload_session_start - DropboxApi::Endpoints::Files::UploadSessionStart + #users + DropboxApi::Results::SharedFileMembers
      323. - #users - DropboxApi::Results::SharedFileMembers + #users + DropboxApi::Results::SharedFolderMembers
      324. - #users - DropboxApi::Results::SharedFolderMembers + valid_values + DropboxApi::Metadata::SearchOrderBy
      325. - valid_values - DropboxApi::Metadata::AccessLevel + valid_values + DropboxApi::Metadata::FileCategory
      326. +
        + valid_values + DropboxApi::Metadata::FileStatus +
        +
      327. + + +
      328. valid_values DropboxApi::Metadata::MemberAction @@ -1932,7 +2100,23 @@

        Method List

      329. +
      330. +
        + valid_values + DropboxApi::Metadata::SearchMatchTypeV2 +
        +
      331. + +
      332. +
        + valid_values + DropboxApi::Metadata::AccessLevel +
        +
      333. + + +
      334. validate DropboxApi::Metadata::Tag @@ -1940,7 +2124,7 @@

        Method List

      335. -
      336. +
      337. #validate_options DropboxApi::OptionsValidator diff --git a/docs/top-level-namespace.html b/docs/top-level-namespace.html index 17e2effe..fb9fd111 100644 --- a/docs/top-level-namespace.html +++ b/docs/top-level-namespace.html @@ -6,15 +6,15 @@ Top Level Namespace - — Documentation by YARD 0.9.19 + — Documentation by YARD 0.9.26 - + - + - @@ -102,9 +102,9 @@

        Defined Under Namespace

        diff --git a/dropbox_api.gemspec b/dropbox_api.gemspec index f895d159..09bf4abc 100644 --- a/dropbox_api.gemspec +++ b/dropbox_api.gemspec @@ -1,28 +1,25 @@ # coding: utf-8 +# frozen_string_literal: true lib = File.expand_path('../lib', __FILE__) $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) require 'dropbox_api/version' Gem::Specification.new do |spec| - spec.name = "dropbox_api" + spec.name = 'dropbox_api' spec.version = DropboxApi::VERSION - spec.authors = ["Jesús Burgos"] - spec.email = ["jburmac@gmail.com"] + spec.authors = ['Jesús Burgos'] + spec.email = ['jburmac@gmail.com'] - spec.summary = "Library for communicating with Dropbox API v2" - spec.homepage = "https://github.com/Jesus/dropbox_api" - spec.license = "MIT" + spec.summary = 'Library for communicating with Dropbox API v2' + spec.homepage = 'https://github.com/Jesus/dropbox_api' + spec.license = 'MIT' spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } - spec.require_paths = ["lib"] + spec.require_paths = ['lib'] - spec.add_development_dependency "bundler", ">= 1.7" - spec.add_development_dependency "rake" - spec.add_development_dependency "rspec" - spec.add_development_dependency "vcr" - spec.add_development_dependency "webmock" + spec.required_ruby_version = '>= 2.3' - spec.add_dependency "faraday", "~> 1.0" - spec.add_dependency "oauth2", "~> 1.1" + spec.add_dependency 'faraday', '< 3.0' + spec.add_dependency 'oauth2', '~> 1.1' end diff --git a/lib/dropbox_api.rb b/lib/dropbox_api.rb index e49c2632..d0b16b35 100644 --- a/lib/dropbox_api.rb +++ b/lib/dropbox_api.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true require 'dropbox_api/version' require 'time' @@ -6,12 +7,14 @@ require 'dropbox_api/authenticator' +require 'dropbox_api/metadata/base' +require 'dropbox_api/metadata/field' +require 'dropbox_api/metadata/namespace_id' + require 'dropbox_api/middleware/decode_result' +require 'dropbox_api/middleware/path_root' require 'dropbox_api/middleware/stack' -require 'dropbox_api/metadata/field' -require 'dropbox_api/metadata/base' - require 'dropbox_api/metadata/tag' require 'dropbox_api/metadata/access_level' require 'dropbox_api/metadata/member_action' @@ -31,6 +34,9 @@ require 'dropbox_api/metadata/member_permission_list' require 'dropbox_api/metadata/add_file_member_result' require 'dropbox_api/metadata/parent_folder_access_info' +require 'dropbox_api/metadata/team_root_info' +require 'dropbox_api/metadata/user_root_info' +require 'dropbox_api/metadata/root_info' require 'dropbox_api/metadata/basic_account' require 'dropbox_api/metadata/link_permissions' require 'dropbox_api/metadata/team' @@ -40,6 +46,16 @@ require 'dropbox_api/metadata/folder' require 'dropbox_api/metadata/deleted' require 'dropbox_api/metadata/resource' +require 'dropbox_api/metadata/metadata_v2' +require 'dropbox_api/metadata/file_category' +require 'dropbox_api/metadata/file_categories_list' +require 'dropbox_api/metadata/file_extensions_list' +require 'dropbox_api/metadata/search_order_by' +require 'dropbox_api/metadata/file_status' +require 'dropbox_api/metadata/search_options' +require 'dropbox_api/metadata/search_match_type_v2' +require 'dropbox_api/metadata/search_match_v2' +require 'dropbox_api/metadata/search_match_field_options' require 'dropbox_api/metadata/shared_folder_policy' require 'dropbox_api/metadata/shared_folder' require 'dropbox_api/metadata/file_link_metadata' @@ -75,6 +91,7 @@ require 'dropbox_api/errors/create_folder_error' require 'dropbox_api/errors/create_shared_link_with_settings_error' require 'dropbox_api/errors/download_error' +require 'dropbox_api/errors/expired_access_token_error' require 'dropbox_api/errors/sharing_file_access_error' require 'dropbox_api/errors/sharing_user_error' require 'dropbox_api/errors/file_member_action_error' @@ -125,8 +142,7 @@ require 'dropbox_api/results/list_shared_links_result' require 'dropbox_api/results/save_url_result' require 'dropbox_api/results/save_url_job_status' -require 'dropbox_api/results/search/match' -require 'dropbox_api/results/search_result' +require 'dropbox_api/results/search_v2_result' require 'dropbox_api/results/share_folder_launch' require 'dropbox_api/results/shared_file_members' require 'dropbox_api/results/shared_folder_members' @@ -173,6 +189,7 @@ require 'dropbox_api/endpoints/files/save_url' require 'dropbox_api/endpoints/files/save_url_check_job_status' require 'dropbox_api/endpoints/files/search' +require 'dropbox_api/endpoints/files/search_continue' require 'dropbox_api/endpoints/files/upload' require 'dropbox_api/endpoints/files/upload_session_start' require 'dropbox_api/endpoints/files/upload_session_append_v2' diff --git a/lib/dropbox_api/authenticator.rb b/lib/dropbox_api/authenticator.rb index e994c654..d2cf025a 100644 --- a/lib/dropbox_api/authenticator.rb +++ b/lib/dropbox_api/authenticator.rb @@ -1,16 +1,13 @@ +# frozen_string_literal: true require 'oauth2' module DropboxApi class Authenticator < OAuth2::Client - extend Forwardable - def initialize(client_id, client_secret) - @auth_code = OAuth2::Client.new(client_id, client_secret, { - :authorize_url => 'https://www.dropbox.com/oauth2/authorize', - :token_url => 'https://api.dropboxapi.com/oauth2/token' - }).auth_code + super(client_id, client_secret, { + authorize_url: 'https://www.dropbox.com/oauth2/authorize', + token_url: 'https://api.dropboxapi.com/oauth2/token' + }) end - - def_delegators :@auth_code, :authorize_url, :get_token end end diff --git a/lib/dropbox_api/chunked_uploader.rb b/lib/dropbox_api/chunked_uploader.rb index e2c2e321..030b61d6 100644 --- a/lib/dropbox_api/chunked_uploader.rb +++ b/lib/dropbox_api/chunked_uploader.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi class ChunkedUploader include DropboxApi::OptionsValidator @@ -13,7 +14,7 @@ def initialize(client, path, i_stream, options = {}) def start chunk = @i_stream.read @chunk_size - chunk = "" if chunk.nil? + chunk = '' if chunk.nil? @cursor = @client.upload_session_start chunk end diff --git a/lib/dropbox_api/client.rb b/lib/dropbox_api/client.rb index 8b2b5e27..a0795b07 100644 --- a/lib/dropbox_api/client.rb +++ b/lib/dropbox_api/client.rb @@ -1,13 +1,35 @@ +# frozen_string_literal: true module DropboxApi class Client - def initialize(oauth_bearer = ENV["DROPBOX_OAUTH_BEARER"]) - @connection_builder = ConnectionBuilder.new(oauth_bearer) + def initialize( + oauth_bearer = ENV['DROPBOX_OAUTH_BEARER'], + access_token: nil, + on_token_refreshed: nil + ) + if access_token + @connection_builder = ConnectionBuilder.new( + access_token: access_token, + on_token_refreshed: on_token_refreshed + ) + elsif oauth_bearer + @connection_builder = ConnectionBuilder.new(oauth_bearer) + else + raise ArgumentError, "Either oauth_bearer or access_token should be set" + end end def middleware @connection_builder.middleware end + def namespace_id=(value) + @connection_builder.namespace_id = value + end + + def namespace_id + @connection_builder.namespace_id + end + # @!visibility private def self.add_endpoint(name, endpoint) define_method(name) do |*args, &block| diff --git a/lib/dropbox_api/connection_builder.rb b/lib/dropbox_api/connection_builder.rb index 81d826bc..110cb6e0 100644 --- a/lib/dropbox_api/connection_builder.rb +++ b/lib/dropbox_api/connection_builder.rb @@ -1,18 +1,53 @@ +# frozen_string_literal: true module DropboxApi class ConnectionBuilder - def initialize(oauth_bearer) - @oauth_bearer = oauth_bearer + attr_accessor :namespace_id + + def initialize(oauth_bearer = nil, access_token: nil, on_token_refreshed: nil) + if access_token + if !access_token.is_a?(OAuth2::AccessToken) + raise ArgumentError, "access_token should be an OAuth2::AccessToken" + end + + @access_token = access_token + @on_token_refreshed = on_token_refreshed + elsif oauth_bearer + @oauth_bearer = oauth_bearer + else + raise ArgumentError, "Either oauth_bearer or access_token should be set" + end end def middleware @middleware ||= MiddleWare::Stack.new end + def can_refresh_access_token? + @access_token && @access_token.refresh_token + end + + def refresh_access_token + @access_token = @access_token.refresh! + @on_token_refreshed.call(@access_token.to_hash) if @on_token_refreshed + end + + private def bearer + @oauth_bearer or oauth_bearer_from_access_token + end + + private def oauth_bearer_from_access_token + refresh_access_token if @access_token.expired? + + @access_token.token + end + def build(url) Faraday.new(url) do |connection| + connection.use DropboxApi::MiddleWare::PathRoot, { + namespace_id: self.namespace_id + } middleware.apply(connection) do - connection.authorization :Bearer, @oauth_bearer - + connection.request :authorization, :Bearer, bearer yield connection end end diff --git a/lib/dropbox_api/endpoints/auth/token_revoke.rb b/lib/dropbox_api/endpoints/auth/token_revoke.rb index 7c6bc42f..7ce41799 100644 --- a/lib/dropbox_api/endpoints/auth/token_revoke.rb +++ b/lib/dropbox_api/endpoints/auth/token_revoke.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Auth class TokenRevoke < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/auth/token/revoke".freeze + Path = '/2/auth/token/revoke' ResultType = DropboxApi::Results::VoidResult ErrorType = nil diff --git a/lib/dropbox_api/endpoints/base.rb b/lib/dropbox_api/endpoints/base.rb index 8207214c..2ccc4268 100644 --- a/lib/dropbox_api/endpoints/base.rb +++ b/lib/dropbox_api/endpoints/base.rb @@ -1,5 +1,11 @@ +# frozen_string_literal: true module DropboxApi::Endpoints class Base + def initialize(builder) + @builder = builder + build_connection + end + def self.add_endpoint(name, &block) define_method(name, block) DropboxApi::Client.add_endpoint(name, self) @@ -9,6 +15,14 @@ def self.add_endpoint(name, &block) def perform_request(params) process_response(get_response(params)) + rescue DropboxApi::Errors::ExpiredAccessTokenError => e + if @builder.can_refresh_access_token? + @builder.refresh_access_token + build_connection + process_response(get_response(params)) + else + raise e + end end def get_response(*args) @@ -23,13 +37,18 @@ def process_response(raw_response) # Status code 409 is "Endpoint-specific error". We need to look at # the response body to build an exception. build_result(raw_response.env[:api_result]) + when 401 + raise DropboxApi::Errors::ExpiredAccessTokenError.build( + raw_response.env[:api_result]['error_summary'], + raw_response.env[:api_result]['error'] + ) when 429 error = DropboxApi::Errors::TooManyRequestsError.build( - raw_response.env[:api_result]["error_summary"], - raw_response.env[:api_result]["error"]["reason"] + raw_response.env[:api_result]['error_summary'], + raw_response.env[:api_result]['error']['reason'] ) - error.retry_after = raw_response.headers["retry-after"].to_i + error.retry_after = raw_response.headers['retry-after'].to_i raise error else @@ -51,7 +70,12 @@ def build_result(api_result) end def run_request(body, headers) - @connection.run_request(self.class::Method, self.class::Path, body, headers) + @connection.run_request( + self.class::Method, + self.class::Path, + body, + headers + ) end end end diff --git a/lib/dropbox_api/endpoints/content_download.rb b/lib/dropbox_api/endpoints/content_download.rb index 71117467..6d346fa2 100644 --- a/lib/dropbox_api/endpoints/content_download.rb +++ b/lib/dropbox_api/endpoints/content_download.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints class ContentDownload < DropboxApi::Endpoints::Base - def initialize(builder) - @connection = builder.build("https://content.dropboxapi.com") do |c| + def build_connection + @connection = @builder.build('https://content.dropboxapi.com') do |c| c.response :decode_result end end diff --git a/lib/dropbox_api/endpoints/content_upload.rb b/lib/dropbox_api/endpoints/content_upload.rb index a371c032..b09c0c70 100644 --- a/lib/dropbox_api/endpoints/content_upload.rb +++ b/lib/dropbox_api/endpoints/content_upload.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints class ContentUpload < DropboxApi::Endpoints::Base - def initialize(builder) - @connection = builder.build("https://content.dropboxapi.com") do |c| + def build_connection + @connection = @builder.build('https://content.dropboxapi.com') do |c| c.response :decode_result end end diff --git a/lib/dropbox_api/endpoints/file_requests/create_file_request.rb b/lib/dropbox_api/endpoints/file_requests/create_file_request.rb index d3147dae..7bfa5451 100644 --- a/lib/dropbox_api/endpoints/file_requests/create_file_request.rb +++ b/lib/dropbox_api/endpoints/file_requests/create_file_request.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class CreateFileRequest < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/file_requests/create".freeze + Path = '/2/file_requests/create' ResultType = DropboxApi::Metadata::FileRequest ErrorType = DropboxApi::Errors::CreateFileRequestError @@ -13,8 +14,8 @@ class CreateFileRequest < DropboxApi::Endpoints::Rpc # this will be relative to the app folder. add_endpoint :create_file_request do |title, destination| perform_request({ - :title => title, - :destination => destination + title: title, + destination: destination }) end end diff --git a/lib/dropbox_api/endpoints/files/copy.rb b/lib/dropbox_api/endpoints/files/copy.rb index dfc2f9ff..effd9a58 100644 --- a/lib/dropbox_api/endpoints/files/copy.rb +++ b/lib/dropbox_api/endpoints/files/copy.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class Copy < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/copy".freeze + Path = '/2/files/copy' ResultType = DropboxApi::Metadata::Resource ErrorType = DropboxApi::Errors::RelocationError @@ -13,8 +14,8 @@ class Copy < DropboxApi::Endpoints::Rpc # @return The moved file. add_endpoint :copy do |from, to| perform_request({ - :from_path => from, - :to_path => to + from_path: from, + to_path: to }) end end diff --git a/lib/dropbox_api/endpoints/files/copy_batch.rb b/lib/dropbox_api/endpoints/files/copy_batch.rb index 2cc8baa4..575b2c9c 100644 --- a/lib/dropbox_api/endpoints/files/copy_batch.rb +++ b/lib/dropbox_api/endpoints/files/copy_batch.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class CopyBatch < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/copy_batch_v2".freeze + Path = '/2/files/copy_batch_v2' ResultType = DropboxApi::Results::CopyBatchResult include DropboxApi::OptionsValidator @@ -28,7 +29,7 @@ class CopyBatch < DropboxApi::Endpoints::Rpc options[:autorename] ||= false perform_request(options.merge({ - :entries => entries + entries: entries })) end end diff --git a/lib/dropbox_api/endpoints/files/copy_batch_check.rb b/lib/dropbox_api/endpoints/files/copy_batch_check.rb index bfec1d2f..b4d8a2d7 100644 --- a/lib/dropbox_api/endpoints/files/copy_batch_check.rb +++ b/lib/dropbox_api/endpoints/files/copy_batch_check.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class CopyBatchCheck < DropboxApi::Endpoints::Rpc Method = :post - Path = '/2/files/copy_batch/check_v2'.freeze + Path = '/2/files/copy_batch/check_v2' ResultType = DropboxApi::Results::RelocationBatchResult ErrorType = DropboxApi::Errors::PollError @@ -14,7 +15,7 @@ class CopyBatchCheck < DropboxApi::Endpoints::Rpc # @return [:in_progress, Array] This could be either the `:in_progress` # flag or a list of job statuses. add_endpoint :copy_batch_check do |async_job_id| - perform_request :async_job_id => async_job_id + perform_request async_job_id: async_job_id end end end diff --git a/lib/dropbox_api/endpoints/files/copy_reference_get.rb b/lib/dropbox_api/endpoints/files/copy_reference_get.rb index ed51361b..53a5cde0 100644 --- a/lib/dropbox_api/endpoints/files/copy_reference_get.rb +++ b/lib/dropbox_api/endpoints/files/copy_reference_get.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class CopyReferenceGet < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/copy_reference/get".freeze + Path = '/2/files/copy_reference/get' ResultType = DropboxApi::Results::GetCopyReferenceResult ErrorType = DropboxApi::Errors::GetCopyReferenceError @@ -14,7 +15,7 @@ class CopyReferenceGet < DropboxApi::Endpoints::Rpc # @return [DropboxApi::Results::GetCopyReferenceResult] add_endpoint :copy_reference_get do |path| perform_request({ - :path => path + path: path }) end end diff --git a/lib/dropbox_api/endpoints/files/copy_reference_save.rb b/lib/dropbox_api/endpoints/files/copy_reference_save.rb index 038341ae..7f838e5d 100644 --- a/lib/dropbox_api/endpoints/files/copy_reference_save.rb +++ b/lib/dropbox_api/endpoints/files/copy_reference_save.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class CopyReferenceSave < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/copy_reference/save".freeze + Path = '/2/files/copy_reference/save' ResultType = DropboxApi::Results::SaveCopyReferenceResult ErrorType = DropboxApi::Errors::SaveCopyReferenceError @@ -14,8 +15,8 @@ class CopyReferenceSave < DropboxApi::Endpoints::Rpc # @return [DropboxApi::Results::SaveCopyReferenceResult] add_endpoint :copy_reference_save do |copy_reference, path| perform_request({ - :copy_reference => copy_reference, - :path => path + copy_reference: copy_reference, + path: path }) end end diff --git a/lib/dropbox_api/endpoints/files/create_folder.rb b/lib/dropbox_api/endpoints/files/create_folder.rb index 5f38da33..d45dabec 100644 --- a/lib/dropbox_api/endpoints/files/create_folder.rb +++ b/lib/dropbox_api/endpoints/files/create_folder.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class CreateFolder < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/create_folder".freeze + Path = '/2/files/create_folder' ResultType = DropboxApi::Metadata::Folder ErrorType = DropboxApi::Errors::CreateFolderError @@ -11,7 +12,7 @@ class CreateFolder < DropboxApi::Endpoints::Rpc # @return [DropboxApi::Metadata::Folder] The new folder. add_endpoint :create_folder do |path| perform_request({ - :path => path + path: path }) end end diff --git a/lib/dropbox_api/endpoints/files/create_folder_batch.rb b/lib/dropbox_api/endpoints/files/create_folder_batch.rb index d24a5a16..ff9cf9f8 100644 --- a/lib/dropbox_api/endpoints/files/create_folder_batch.rb +++ b/lib/dropbox_api/endpoints/files/create_folder_batch.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class CreateFolderBatch < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/create_folder_batch".freeze + Path = '/2/files/create_folder_batch' ResultType = DropboxApi::Results::CreateFolderBatchResult include DropboxApi::OptionsValidator @@ -33,7 +34,7 @@ class CreateFolderBatch < DropboxApi::Endpoints::Rpc options[:force_async] ||= false perform_request(options.merge({ - :paths => paths + paths: paths })) end end diff --git a/lib/dropbox_api/endpoints/files/create_folder_batch_check.rb b/lib/dropbox_api/endpoints/files/create_folder_batch_check.rb index caa856f4..bfb95486 100644 --- a/lib/dropbox_api/endpoints/files/create_folder_batch_check.rb +++ b/lib/dropbox_api/endpoints/files/create_folder_batch_check.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class CreateFolderBatchCheck < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/create_folder_batch/check".freeze + Path = '/2/files/create_folder_batch/check' ResultType = DropboxApi::Results::CreateFolderBatchResult ErrorType = DropboxApi::Errors::PollError @@ -14,7 +15,7 @@ class CreateFolderBatchCheck < DropboxApi::Endpoints::Rpc # @return [Array] A list of one result for each entry. add_endpoint :create_folder_batch_check do |async_job_id| perform_request({ - :async_job_id => async_job_id + async_job_id: async_job_id }) end end diff --git a/lib/dropbox_api/endpoints/files/delete.rb b/lib/dropbox_api/endpoints/files/delete.rb index 6e0b61fa..a75bf4ec 100644 --- a/lib/dropbox_api/endpoints/files/delete.rb +++ b/lib/dropbox_api/endpoints/files/delete.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class Delete < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/delete".freeze + Path = '/2/files/delete' ResultType = DropboxApi::Metadata::Resource ErrorType = DropboxApi::Errors::DeleteError @@ -25,7 +26,7 @@ class Delete < DropboxApi::Endpoints::Rpc validate_options([:parent_rev], options) perform_request options.merge({ - :path => path + path: path }) end end diff --git a/lib/dropbox_api/endpoints/files/delete_batch.rb b/lib/dropbox_api/endpoints/files/delete_batch.rb index a22382f5..20b8e711 100644 --- a/lib/dropbox_api/endpoints/files/delete_batch.rb +++ b/lib/dropbox_api/endpoints/files/delete_batch.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class DeleteBatch < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/delete_batch".freeze + Path = '/2/files/delete_batch' ResultType = DropboxApi::Results::DeleteBatchResult # Delete multiple files/folders at once. @@ -15,7 +16,7 @@ class DeleteBatch < DropboxApi::Endpoints::Rpc # @return [String, Array] Either the job id or the list of job statuses. add_endpoint :delete_batch do |entries| perform_request({ - :entries => entries + entries: entries }) end end diff --git a/lib/dropbox_api/endpoints/files/delete_batch_check.rb b/lib/dropbox_api/endpoints/files/delete_batch_check.rb index 949ea6cb..b5345ba3 100644 --- a/lib/dropbox_api/endpoints/files/delete_batch_check.rb +++ b/lib/dropbox_api/endpoints/files/delete_batch_check.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class DeleteBatchCheck < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/delete_batch/check".freeze + Path = '/2/files/delete_batch/check' ResultType = DropboxApi::Results::DeleteBatchResult ErrorType = DropboxApi::Errors::PollError @@ -13,7 +14,7 @@ class DeleteBatchCheck < DropboxApi::Endpoints::Rpc # flag or a list of job statuses. add_endpoint :delete_batch_check do |async_job_id| perform_request({ - :async_job_id => async_job_id + async_job_id: async_job_id }) end end diff --git a/lib/dropbox_api/endpoints/files/download.rb b/lib/dropbox_api/endpoints/files/download.rb index 917128e8..3642f672 100644 --- a/lib/dropbox_api/endpoints/files/download.rb +++ b/lib/dropbox_api/endpoints/files/download.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class Download < DropboxApi::Endpoints::ContentDownload Method = :post - Path = "/2/files/download".freeze + Path = '/2/files/download' ResultType = DropboxApi::Metadata::File ErrorType = DropboxApi::Errors::DownloadError @@ -9,7 +10,7 @@ class Download < DropboxApi::Endpoints::ContentDownload # # @param path [String] The path of the file to download. add_endpoint :download do |path, &block| - perform_request({:path => path}, &block) + perform_request({path: path}, &block) end end end diff --git a/lib/dropbox_api/endpoints/files/get_metadata.rb b/lib/dropbox_api/endpoints/files/get_metadata.rb index c9c71ae0..6d6ec181 100644 --- a/lib/dropbox_api/endpoints/files/get_metadata.rb +++ b/lib/dropbox_api/endpoints/files/get_metadata.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class GetMetadata < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/get_metadata".freeze + Path = '/2/files/get_metadata' ResultType = DropboxApi::Metadata::Resource ErrorType = DropboxApi::Errors::GetMetadataError @@ -34,7 +35,7 @@ class GetMetadata < DropboxApi::Endpoints::Rpc ], options) perform_request(options.merge({ - :path => path + path: path })) end end diff --git a/lib/dropbox_api/endpoints/files/get_preview.rb b/lib/dropbox_api/endpoints/files/get_preview.rb index 203414db..18926b9a 100644 --- a/lib/dropbox_api/endpoints/files/get_preview.rb +++ b/lib/dropbox_api/endpoints/files/get_preview.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class GetPreview < DropboxApi::Endpoints::ContentDownload Method = :post - Path = "/2/files/get_preview".freeze + Path = '/2/files/get_preview' ResultType = DropboxApi::Metadata::File ErrorType = DropboxApi::Errors::PreviewError @@ -11,7 +12,7 @@ class GetPreview < DropboxApi::Endpoints::ContentDownload # # @param path [String] The path of the file to preview. add_endpoint :get_preview do |path, &block| - perform_request({:path => path}, &block) + perform_request({path: path}, &block) end end end diff --git a/lib/dropbox_api/endpoints/files/get_temporary_link.rb b/lib/dropbox_api/endpoints/files/get_temporary_link.rb index 890c438f..cf84487a 100644 --- a/lib/dropbox_api/endpoints/files/get_temporary_link.rb +++ b/lib/dropbox_api/endpoints/files/get_temporary_link.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class GetTemporaryLink < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/get_temporary_link".freeze + Path = '/2/files/get_temporary_link' ResultType = DropboxApi::Results::GetTemporaryLinkResult ErrorType = DropboxApi::Errors::GetMetadataError @@ -11,7 +12,7 @@ class GetTemporaryLink < DropboxApi::Endpoints::Rpc # # @param path [String] The path to the file you want a temporary link to. add_endpoint :get_temporary_link do |path| - perform_request({:path => path}) + perform_request({path: path}) end end end diff --git a/lib/dropbox_api/endpoints/files/get_thumbnail.rb b/lib/dropbox_api/endpoints/files/get_thumbnail.rb index 958d06c0..61b8ecdf 100644 --- a/lib/dropbox_api/endpoints/files/get_thumbnail.rb +++ b/lib/dropbox_api/endpoints/files/get_thumbnail.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class GetThumbnail < DropboxApi::Endpoints::ContentDownload Method = :post - Path = "/2/files/get_thumbnail".freeze + Path = '/2/files/get_thumbnail' ResultType = DropboxApi::Metadata::File ErrorType = DropboxApi::Errors::PreviewError @@ -50,7 +51,7 @@ class GetThumbnail < DropboxApi::Endpoints::ContentDownload options[:size] ||= :w64h64 perform_request(options.merge({ - :path => path + path: path }), &block) end end diff --git a/lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb b/lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb index 74397d29..7c558e37 100644 --- a/lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb +++ b/lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class GetThumbnailBatch < DropboxApi::Endpoints::RpcContent Method = :post - Path = "/2/files/get_thumbnail_batch".freeze + Path = '/2/files/get_thumbnail_batch' ResultType = DropboxApi::Results::GetThumbnailBatchResult ErrorType = DropboxApi::Errors::ThumbnailBatchError @@ -25,12 +26,12 @@ class GetThumbnailBatch < DropboxApi::Endpoints::RpcContent options[:size] ||= :w64h64 options[:mode] ||= :strict - perform_request :entries => build_entries_params(paths, options) + perform_request entries: build_entries_params(paths, options) end def build_entries_params(paths, options) paths.map do |path| - options.merge({ :path => path }) + options.merge({ path: path }) end end diff --git a/lib/dropbox_api/endpoints/files/list_folder.rb b/lib/dropbox_api/endpoints/files/list_folder.rb index e030856d..6bb00984 100644 --- a/lib/dropbox_api/endpoints/files/list_folder.rb +++ b/lib/dropbox_api/endpoints/files/list_folder.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class ListFolder < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/list_folder".freeze + Path = '/2/files/list_folder' ResultType = DropboxApi::Results::ListFolderResult ErrorType = DropboxApi::Errors::ListFolderError @@ -41,7 +42,7 @@ class ListFolder < DropboxApi::Endpoints::Rpc options[:limit] = options[:limit] if options[:limit] perform_request options.merge({ - :path => path + path: path }) end diff --git a/lib/dropbox_api/endpoints/files/list_folder_continue.rb b/lib/dropbox_api/endpoints/files/list_folder_continue.rb index f140a3f8..3947cf6b 100644 --- a/lib/dropbox_api/endpoints/files/list_folder_continue.rb +++ b/lib/dropbox_api/endpoints/files/list_folder_continue.rb @@ -1,10 +1,11 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class ListFolderContinue < DropboxApi::Endpoints::Rpc # NOTE: This hasn't been tested with real data, I couldn't make a query # long enough to enable the `has_more` attribute in the # `ListFolderResult`. Method = :post - Path = "/2/files/list_folder/continue".freeze + Path = '/2/files/list_folder/continue' ResultType = DropboxApi::Results::ListFolderResult ErrorType = DropboxApi::Errors::ListFolderContinueError @@ -14,7 +15,7 @@ class ListFolderContinue < DropboxApi::Endpoints::Rpc # @param cursor [String] The cursor returned by your last call to # list_folder or list_folder_continue. add_endpoint :list_folder_continue do |cursor| - perform_request :cursor => cursor + perform_request cursor: cursor end end end diff --git a/lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb b/lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb index 71b01f3e..bdfecb13 100644 --- a/lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb +++ b/lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class ListFolderGetLatestCursor < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/list_folder/get_latest_cursor".freeze + Path = '/2/files/list_folder/get_latest_cursor' ResultType = DropboxApi::Results::ListFolderGetLatestCursorResult ErrorType = DropboxApi::Errors::ListFolderError diff --git a/lib/dropbox_api/endpoints/files/list_folder_longpoll.rb b/lib/dropbox_api/endpoints/files/list_folder_longpoll.rb index c3363094..8e773c0e 100644 --- a/lib/dropbox_api/endpoints/files/list_folder_longpoll.rb +++ b/lib/dropbox_api/endpoints/files/list_folder_longpoll.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class ListFolderLongpoll < DropboxApi::Endpoints::RpcNotify Method = :post - Path = "/2/files/list_folder/longpoll".freeze + Path = '/2/files/list_folder/longpoll' ResultType = DropboxApi::Results::ListFolderLongpollResult ErrorType = DropboxApi::Errors::ListFolderLongpollError @@ -28,7 +29,7 @@ class ListFolderLongpoll < DropboxApi::Endpoints::RpcNotify options[:timeout] ||= 30 perform_request options.merge({ - :cursor => cursor + cursor: cursor }) end end diff --git a/lib/dropbox_api/endpoints/files/list_revisions.rb b/lib/dropbox_api/endpoints/files/list_revisions.rb index 4988e1cb..9d3c7418 100644 --- a/lib/dropbox_api/endpoints/files/list_revisions.rb +++ b/lib/dropbox_api/endpoints/files/list_revisions.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class ListRevisions < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/list_revisions".freeze + Path = '/2/files/list_revisions' ResultType = DropboxApi::Results::ListRevisionsResult ErrorType = DropboxApi::Errors::ListRevisionsError @@ -19,7 +20,7 @@ class ListRevisions < DropboxApi::Endpoints::Rpc options[:limit] ||= 10 perform_request options.merge({ - :path => path + path: path }) end end diff --git a/lib/dropbox_api/endpoints/files/move.rb b/lib/dropbox_api/endpoints/files/move.rb index 69c95bb7..21e3d977 100644 --- a/lib/dropbox_api/endpoints/files/move.rb +++ b/lib/dropbox_api/endpoints/files/move.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class Move < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/move".freeze + Path = '/2/files/move' ResultType = DropboxApi::Metadata::Resource ErrorType = DropboxApi::Errors::RelocationError @@ -25,8 +26,8 @@ class Move < DropboxApi::Endpoints::Rpc ], options) perform_request options.merge({ - :from_path => from, - :to_path => to + from_path: from, + to_path: to }) end end diff --git a/lib/dropbox_api/endpoints/files/permanently_delete.rb b/lib/dropbox_api/endpoints/files/permanently_delete.rb index 1cb74622..5cfa5019 100644 --- a/lib/dropbox_api/endpoints/files/permanently_delete.rb +++ b/lib/dropbox_api/endpoints/files/permanently_delete.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class PermanentlyDelete < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/permanently_delete".freeze + Path = '/2/files/permanently_delete' ResultType = DropboxApi::Results::VoidResult ErrorType = DropboxApi::Errors::DeleteError @@ -21,7 +22,7 @@ class PermanentlyDelete < DropboxApi::Endpoints::Rpc validate_options([:parent_rev], options) perform_request options.merge({ - :path => path + path: path }) end end diff --git a/lib/dropbox_api/endpoints/files/restore.rb b/lib/dropbox_api/endpoints/files/restore.rb index 9dee4f9d..f3b4a671 100644 --- a/lib/dropbox_api/endpoints/files/restore.rb +++ b/lib/dropbox_api/endpoints/files/restore.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class Restore < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/restore".freeze + Path = '/2/files/restore' ResultType = DropboxApi::Metadata::File ErrorType = DropboxApi::Errors::RestoreError @@ -11,8 +12,8 @@ class Restore < DropboxApi::Endpoints::Rpc # @param rev [String] The revision to restore for the file. add_endpoint :restore do |path, rev| perform_request({ - :path => path, - :rev => rev + path: path, + rev: rev }) end end diff --git a/lib/dropbox_api/endpoints/files/save_url.rb b/lib/dropbox_api/endpoints/files/save_url.rb index 19de4581..d7f5cf5e 100644 --- a/lib/dropbox_api/endpoints/files/save_url.rb +++ b/lib/dropbox_api/endpoints/files/save_url.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class SaveUrl < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/save_url".freeze + Path = '/2/files/save_url' ResultType = DropboxApi::Results::SaveUrlResult ErrorType = DropboxApi::Errors::SaveUrlError @@ -14,8 +15,8 @@ class SaveUrl < DropboxApi::Endpoints::Rpc # @return Either the saved file or a reference to the async job. add_endpoint :save_url do |path, url| perform_request({ - :path => path, - :url => url + path: path, + url: url }) end end diff --git a/lib/dropbox_api/endpoints/files/save_url_check_job_status.rb b/lib/dropbox_api/endpoints/files/save_url_check_job_status.rb index a639a5da..310f2d33 100644 --- a/lib/dropbox_api/endpoints/files/save_url_check_job_status.rb +++ b/lib/dropbox_api/endpoints/files/save_url_check_job_status.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class SaveUrlCheckJobStatus < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/save_url/check_job_status".freeze + Path = '/2/files/save_url/check_job_status' ResultType = DropboxApi::Results::SaveUrlJobStatus ErrorType = DropboxApi::Errors::PollError @@ -12,7 +13,7 @@ class SaveUrlCheckJobStatus < DropboxApi::Endpoints::Rpc # @return The current status of the job. add_endpoint :save_url_check_job_status do |job_id| perform_request({ - :async_job_id => job_id + async_job_id: job_id }) end end diff --git a/lib/dropbox_api/endpoints/files/search.rb b/lib/dropbox_api/endpoints/files/search.rb index e3aa789c..be872fc3 100644 --- a/lib/dropbox_api/endpoints/files/search.rb +++ b/lib/dropbox_api/endpoints/files/search.rb @@ -1,8 +1,9 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class Search < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/files/search".freeze - ResultType = DropboxApi::Results::SearchResult + Path = '/2/files/search_v2' + ResultType = DropboxApi::Results::SearchV2Result ErrorType = DropboxApi::Errors::SearchError include DropboxApi::OptionsValidator @@ -12,32 +13,20 @@ class Search < DropboxApi::Endpoints::Rpc # Note: Recent changes may not immediately be reflected in search results # due to a short delay in indexing. # - # @param query [String] The string to search for. The search string is - # split on spaces into multiple tokens. For file name searching, the last - # token is used for prefix matching (i.e. "bat c" matches "bat cave" but - # not "batman car"). - # @param path [String] The path in the user's Dropbox to search. - # @option options start [Numeric] The starting index within the search - # results (used for paging). The default for this field is 0. - # @option options max_results [Numeric] The maximum number of search - # results to return. The default for this field is 100. - # @option options mode [:filename, :filename_and_content, :deleted_filename] - # The search mode. Note that searching file content is only - # available for Dropbox Business accounts. The default is filename. - add_endpoint :search do |query, path = "", options = {}| - validate_options([ - :start, - :max_results, - :mode - ], options) - options[:start] ||= 0 - options[:max_results] ||= 100 - options[:mode] ||= :filename + # @param query [String] The string to search for. May match across + # multiple fields based on the request arguments. + # @param options [DropboxApi::Metadata::SearchOptions] Options for more + # targeted search results. This field is optional. + # @param match_field_options [DropboxApi::Metadata::SearchMatchFieldOptions] + # Options for search results match fields. This field is optional. + add_endpoint :search do |query, options = nil, match_field_options = nil| + params = { query: query } - perform_request options.merge({ - :query => query, - :path => path - }) + params[:options] = options.to_hash unless options.nil? + + params[:match_field_options] = match_field_options.to_hash unless match_field_options.nil? + + perform_request(params) end end end diff --git a/lib/dropbox_api/endpoints/files/search_continue.rb b/lib/dropbox_api/endpoints/files/search_continue.rb new file mode 100644 index 00000000..1987f446 --- /dev/null +++ b/lib/dropbox_api/endpoints/files/search_continue.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true +module DropboxApi::Endpoints::Files + class SearchContinue < DropboxApi::Endpoints::Rpc + Method = :post + Path = '/2/files/search/continue_v2' + ResultType = DropboxApi::Results::SearchV2Result + ErrorType = DropboxApi::Errors::SearchError + + include DropboxApi::OptionsValidator + + # Fetches the next page of search results returned from search:2. + # Note: search:2 along with search/continue:2 can only be used to retrieve a maximum of 10,000 matches. + # Recent changes may not immediately be reflected in search results due to a short delay in indexing. + # Duplicate results may be returned across pages. Some results may not be returned. + + + # @param cursor [String] The cursor returned by your last call to + # search:2. Used to fetch the next page of results. + add_endpoint :search_continue do |cursor| + perform_request cursor: cursor + end + end +end diff --git a/lib/dropbox_api/endpoints/files/upload.rb b/lib/dropbox_api/endpoints/files/upload.rb index 98cdf064..4012dd61 100644 --- a/lib/dropbox_api/endpoints/files/upload.rb +++ b/lib/dropbox_api/endpoints/files/upload.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class Upload < DropboxApi::Endpoints::ContentUpload Method = :post - Path = "/2/files/upload".freeze + Path = '/2/files/upload' ResultType = DropboxApi::Metadata::File ErrorType = DropboxApi::Errors::UploadError diff --git a/lib/dropbox_api/endpoints/files/upload_session_append_v2.rb b/lib/dropbox_api/endpoints/files/upload_session_append_v2.rb index b6027398..1ca43cc9 100644 --- a/lib/dropbox_api/endpoints/files/upload_session_append_v2.rb +++ b/lib/dropbox_api/endpoints/files/upload_session_append_v2.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class UploadSessionAppendV2 < DropboxApi::Endpoints::ContentUpload Method = :post - Path = "/2/files/upload_session/append_v2".freeze + Path = '/2/files/upload_session/append_v2' ResultType = DropboxApi::Results::VoidResult ErrorType = DropboxApi::Errors::UploadSessionLookupError @@ -41,7 +42,7 @@ class UploadSessionAppendV2 < DropboxApi::Endpoints::ContentUpload ], options) perform_request(options.merge({ - :cursor => cursor.to_hash + cursor: cursor.to_hash }), content) cursor.offset += content.bytesize diff --git a/lib/dropbox_api/endpoints/files/upload_session_finish.rb b/lib/dropbox_api/endpoints/files/upload_session_finish.rb index ecc3efd1..f54e1480 100644 --- a/lib/dropbox_api/endpoints/files/upload_session_finish.rb +++ b/lib/dropbox_api/endpoints/files/upload_session_finish.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class UploadSessionFinish < DropboxApi::Endpoints::ContentUpload Method = :post - Path = "/2/files/upload_session/finish".freeze + Path = '/2/files/upload_session/finish' ResultType = DropboxApi::Metadata::File ErrorType = DropboxApi::Errors::UploadSessionFinishError @@ -20,8 +21,8 @@ class UploadSessionFinish < DropboxApi::Endpoints::ContentUpload # other optional modifiers for the commit. add_endpoint :upload_session_finish do |cursor, commit, content = nil| perform_request({ - :cursor => cursor.to_hash, - :commit => commit.to_hash + cursor: cursor.to_hash, + commit: commit.to_hash }, content) end end diff --git a/lib/dropbox_api/endpoints/files/upload_session_start.rb b/lib/dropbox_api/endpoints/files/upload_session_start.rb index bbbc9dbc..ce33c18f 100644 --- a/lib/dropbox_api/endpoints/files/upload_session_start.rb +++ b/lib/dropbox_api/endpoints/files/upload_session_start.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Files class UploadSessionStart < DropboxApi::Endpoints::ContentUpload Method = :post - Path = "/2/files/upload_session/start".freeze + Path = '/2/files/upload_session/start' ResultType = DropboxApi::Results::UploadSessionStart ErrorType = nil @@ -30,8 +31,8 @@ class UploadSessionStart < DropboxApi::Endpoints::ContentUpload session = perform_request(options, content) DropboxApi::Metadata::UploadSessionCursor.new({ - "session_id" => session.session_id, - "offset" => content.bytesize + 'session_id' => session.session_id, + 'offset' => content.bytesize }) end end diff --git a/lib/dropbox_api/endpoints/rpc.rb b/lib/dropbox_api/endpoints/rpc.rb index b9d07708..eb0c3ea5 100644 --- a/lib/dropbox_api/endpoints/rpc.rb +++ b/lib/dropbox_api/endpoints/rpc.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints class Rpc < DropboxApi::Endpoints::Base - def initialize(builder) - @connection = builder.build("https://api.dropboxapi.com") do |c| + def build_connection + @connection = @builder.build('https://api.dropboxapi.com') do |c| c.response :decode_result end end diff --git a/lib/dropbox_api/endpoints/rpc_content.rb b/lib/dropbox_api/endpoints/rpc_content.rb index b98aa589..58172c5b 100644 --- a/lib/dropbox_api/endpoints/rpc_content.rb +++ b/lib/dropbox_api/endpoints/rpc_content.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints class RpcContent < DropboxApi::Endpoints::Rpc - def initialize(builder) - @connection = builder.build("https://content.dropboxapi.com") do |c| + def build_connection + @connection = @builder.build('https://content.dropboxapi.com') do |c| c.response :decode_result end end diff --git a/lib/dropbox_api/endpoints/rpc_notify.rb b/lib/dropbox_api/endpoints/rpc_notify.rb index 6128adcc..a2d2b6e9 100644 --- a/lib/dropbox_api/endpoints/rpc_notify.rb +++ b/lib/dropbox_api/endpoints/rpc_notify.rb @@ -1,8 +1,9 @@ +# frozen_string_literal: true module DropboxApi::Endpoints class RpcNotify < DropboxApi::Endpoints::Rpc - def initialize(builder) - @connection = builder.build("https://notify.dropboxapi.com") do |c| - c.headers.delete 'Authorization' + def build_connection + @connection = @builder.build('https://notify.dropboxapi.com') do |c| + c.builder.handlers.delete(Faraday::Request::Authorization) c.response :decode_result end diff --git a/lib/dropbox_api/endpoints/sharing/add_file_member.rb b/lib/dropbox_api/endpoints/sharing/add_file_member.rb index b8fed1b9..a2aa9831 100644 --- a/lib/dropbox_api/endpoints/sharing/add_file_member.rb +++ b/lib/dropbox_api/endpoints/sharing/add_file_member.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Sharing class AddFileMember < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/sharing/add_file_member".freeze + Path = '/2/sharing/add_file_member' ResultType = DropboxApi::Results::AddFileMemberResultList ErrorType = DropboxApi::Errors::AddFileMemberError @@ -38,8 +39,8 @@ class AddFileMember < DropboxApi::Endpoints::Rpc options[:add_message_as_comment] ||= false perform_request options.merge({ - :file => file, - :members => build_members_param(members) + file: file, + members: build_members_param(members) }) end diff --git a/lib/dropbox_api/endpoints/sharing/add_folder_member.rb b/lib/dropbox_api/endpoints/sharing/add_folder_member.rb index 60401a98..cb19475d 100644 --- a/lib/dropbox_api/endpoints/sharing/add_folder_member.rb +++ b/lib/dropbox_api/endpoints/sharing/add_folder_member.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Sharing class AddFolderMember < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/sharing/add_folder_member".freeze + Path = '/2/sharing/add_folder_member' ResultType = DropboxApi::Results::VoidResult ErrorType = DropboxApi::Errors::AddFolderMemberError @@ -41,8 +42,8 @@ class AddFolderMember < DropboxApi::Endpoints::Rpc options[:custom_message] ||= nil perform_request options.merge({ - :shared_folder_id => folder_id.to_s, - :members => build_members_param(members) + shared_folder_id: folder_id.to_s, + members: build_members_param(members) }) end diff --git a/lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb b/lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb index 5e16cf7b..d5c2e98e 100644 --- a/lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb +++ b/lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Sharing class CreateSharedLinkWithSettings < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/sharing/create_shared_link_with_settings".freeze + Path = '/2/sharing/create_shared_link_with_settings' ResultType = DropboxApi::Metadata::SharedLinkMetadata ErrorType = DropboxApi::Errors::CreateSharedLinkWithSettingsError @@ -39,8 +40,8 @@ class CreateSharedLinkWithSettings < DropboxApi::Endpoints::Rpc settings[:expires] ||= nil perform_request({ - :path => path, - :settings => settings + path: path, + settings: settings }) end end diff --git a/lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb b/lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb index eac654b9..371d0a48 100644 --- a/lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb +++ b/lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Sharing class GetSharedLinkMetadata < DropboxApi::Endpoints::Rpc Method = :post - Path = '/2/sharing/get_shared_link_metadata'.freeze + Path = '/2/sharing/get_shared_link_metadata' ResultType = DropboxApi::Metadata::SharedLinkMetadata ErrorType = DropboxApi::Errors::SharedLinkError @@ -23,7 +24,7 @@ class GetSharedLinkMetadata < DropboxApi::Endpoints::Rpc validate_options([:path, :link_password], options) perform_request options.merge( - :url => preview_link + url: preview_link ) end end diff --git a/lib/dropbox_api/endpoints/sharing/list_file_members.rb b/lib/dropbox_api/endpoints/sharing/list_file_members.rb index 220e4c55..1d02a897 100644 --- a/lib/dropbox_api/endpoints/sharing/list_file_members.rb +++ b/lib/dropbox_api/endpoints/sharing/list_file_members.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Sharing class ListFileMembers < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/sharing/list_file_members".freeze + Path = '/2/sharing/list_file_members' ResultType = DropboxApi::Results::SharedFileMembers ErrorType = DropboxApi::Errors::SharingFileAccessError @@ -38,8 +39,8 @@ class ListFileMembers < DropboxApi::Endpoints::Rpc options[:limit] ||= 100 perform_request options.merge({ - :file => file_id, - :actions => DropboxApi::Metadata::MemberActionList.new(actions) + file: file_id, + actions: DropboxApi::Metadata::MemberActionList.new(actions) }) end end diff --git a/lib/dropbox_api/endpoints/sharing/list_folder_members.rb b/lib/dropbox_api/endpoints/sharing/list_folder_members.rb index ccdd3233..db15f3c8 100644 --- a/lib/dropbox_api/endpoints/sharing/list_folder_members.rb +++ b/lib/dropbox_api/endpoints/sharing/list_folder_members.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Sharing class ListFolderMembers < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/sharing/list_folder_members".freeze + Path = '/2/sharing/list_folder_members' ResultType = DropboxApi::Results::SharedFolderMembers ErrorType = DropboxApi::Errors::SharedFolderAccessError @@ -31,8 +32,8 @@ class ListFolderMembers < DropboxApi::Endpoints::Rpc options[:limit] ||= 100 perform_request options.merge({ - :shared_folder_id => folder_id, - :actions => DropboxApi::Metadata::MemberActionList.new(actions) + shared_folder_id: folder_id, + actions: DropboxApi::Metadata::MemberActionList.new(actions) }) end end diff --git a/lib/dropbox_api/endpoints/sharing/list_shared_links.rb b/lib/dropbox_api/endpoints/sharing/list_shared_links.rb index 2aa7dc0a..05d3e959 100644 --- a/lib/dropbox_api/endpoints/sharing/list_shared_links.rb +++ b/lib/dropbox_api/endpoints/sharing/list_shared_links.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Sharing class ListSharedLinks < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/sharing/list_shared_links".freeze + Path = '/2/sharing/list_shared_links' ResultType = DropboxApi::Results::ListSharedLinksResult ErrorType = DropboxApi::Errors::ListSharedLinksError diff --git a/lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb b/lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb index 815a444c..1d363846 100644 --- a/lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb +++ b/lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Sharing class RevokeSharedLink < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/sharing/revoke_shared_link".freeze + Path = '/2/sharing/revoke_shared_link' ResultType = DropboxApi::Results::VoidResult ErrorType = DropboxApi::Errors::RevokeSharedLinkError @@ -16,7 +17,7 @@ class RevokeSharedLink < DropboxApi::Endpoints::Rpc add_endpoint :revoke_shared_link do |url| perform_request({ - :url => url + url: url }) end end diff --git a/lib/dropbox_api/endpoints/sharing/share_folder.rb b/lib/dropbox_api/endpoints/sharing/share_folder.rb index 3b5e6a73..f242ae2e 100644 --- a/lib/dropbox_api/endpoints/sharing/share_folder.rb +++ b/lib/dropbox_api/endpoints/sharing/share_folder.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Sharing class ShareFolder < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/sharing/share_folder".freeze + Path = '/2/sharing/share_folder' ResultType = DropboxApi::Results::ShareFolderLaunch ErrorType = DropboxApi::Errors::ShareFolderError @@ -47,7 +48,7 @@ class ShareFolder < DropboxApi::Endpoints::Rpc begin perform_request options.merge({ - :path => path + path: path }) rescue DropboxApi::Errors::AlreadySharedError => error error.shared_folder diff --git a/lib/dropbox_api/endpoints/sharing/unshare_file.rb b/lib/dropbox_api/endpoints/sharing/unshare_file.rb index ce187824..7b7f6f55 100644 --- a/lib/dropbox_api/endpoints/sharing/unshare_file.rb +++ b/lib/dropbox_api/endpoints/sharing/unshare_file.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Sharing class UnshareFile < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/sharing/unshare_file".freeze + Path = '/2/sharing/unshare_file' ResultType = DropboxApi::Results::VoidResult ErrorType = DropboxApi::Errors::UnshareFileError @@ -12,7 +13,7 @@ class UnshareFile < DropboxApi::Endpoints::Rpc # @param file [String] Path or ID of the file in the user's Dropbox to unshare. add_endpoint :unshare_file do |file| perform_request({ - :file => file + file: file }) end end diff --git a/lib/dropbox_api/endpoints/users/get_account.rb b/lib/dropbox_api/endpoints/users/get_account.rb index e317ac5c..7f5ab112 100644 --- a/lib/dropbox_api/endpoints/users/get_account.rb +++ b/lib/dropbox_api/endpoints/users/get_account.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Users class GetAccount < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/users/get_account".freeze + Path = '/2/users/get_account' ResultType = DropboxApi::Metadata::BasicAccount ErrorType = DropboxApi::Errors::GetAccountError @@ -10,7 +11,7 @@ class GetAccount < DropboxApi::Endpoints::Rpc # @param account_id [String] A user's account identifier. # @return [BasicAccount] Basic information about any account. add_endpoint :get_account do |account_id| - perform_request :account_id => account_id + perform_request account_id: account_id end end end diff --git a/lib/dropbox_api/endpoints/users/get_account_batch.rb b/lib/dropbox_api/endpoints/users/get_account_batch.rb index 666d4c55..38c95757 100644 --- a/lib/dropbox_api/endpoints/users/get_account_batch.rb +++ b/lib/dropbox_api/endpoints/users/get_account_batch.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Users class GetAccountBatch < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/users/get_account_batch".freeze + Path = '/2/users/get_account_batch' ResultType = DropboxApi::Results::BasicAccountBatch ErrorType = DropboxApi::Errors::GetAccountError @@ -12,7 +13,7 @@ class GetAccountBatch < DropboxApi::Endpoints::Rpc # contain any duplicate account IDs. # @return [Array] Basic information about any account. add_endpoint :get_account_batch do |account_ids| - perform_request :account_ids => account_ids + perform_request account_ids: account_ids end end end diff --git a/lib/dropbox_api/endpoints/users/get_current_account.rb b/lib/dropbox_api/endpoints/users/get_current_account.rb index 8befd825..ea9bfcc4 100644 --- a/lib/dropbox_api/endpoints/users/get_current_account.rb +++ b/lib/dropbox_api/endpoints/users/get_current_account.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Users class GetCurrentAccount < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/users/get_current_account".freeze + Path = '/2/users/get_current_account' ResultType = DropboxApi::Metadata::BasicAccount ErrorType = nil diff --git a/lib/dropbox_api/endpoints/users/get_space_usage.rb b/lib/dropbox_api/endpoints/users/get_space_usage.rb index 13417728..bd697fb6 100644 --- a/lib/dropbox_api/endpoints/users/get_space_usage.rb +++ b/lib/dropbox_api/endpoints/users/get_space_usage.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Endpoints::Users class GetSpaceUsage < DropboxApi::Endpoints::Rpc Method = :post - Path = "/2/users/get_space_usage".freeze + Path = '/2/users/get_space_usage' ResultType = DropboxApi::Metadata::SpaceUsage ErrorType = nil diff --git a/lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb b/lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb index eddd210b..3fa9914c 100644 --- a/lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb +++ b/lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi class Client # Creates a new file using the *upload session* endpoints. You can use diff --git a/lib/dropbox_api/errors/add_file_member_error.rb b/lib/dropbox_api/errors/add_file_member_error.rb index 41d252ef..7c05a5c5 100644 --- a/lib/dropbox_api/errors/add_file_member_error.rb +++ b/lib/dropbox_api/errors/add_file_member_error.rb @@ -1,10 +1,11 @@ +# frozen_string_literal: true module DropboxApi::Errors class AddFileMemberError < BasicError ErrorSubtypes = { - :user_error => SharingUserError, - :access_error => SharingFileAccessError, - :rate_limit => RateLimitError, - :invalid_comment => InvalidCommentError + user_error: SharingUserError, + access_error: SharingFileAccessError, + rate_limit: RateLimitError, + invalid_comment: InvalidCommentError }.freeze end end diff --git a/lib/dropbox_api/errors/add_folder_member_error.rb b/lib/dropbox_api/errors/add_folder_member_error.rb index 859520ab..91c17bef 100644 --- a/lib/dropbox_api/errors/add_folder_member_error.rb +++ b/lib/dropbox_api/errors/add_folder_member_error.rb @@ -1,16 +1,17 @@ +# frozen_string_literal: true module DropboxApi::Errors class AddFolderMemberError < BasicError ErrorSubtypes = { - :access_error => SharedFolderAccessError, - :email_unverified => EmailUnverifiedError, - :bad_member => AddMemberSelectorError, - :cant_share_outside_team => CantShareOutsideTeamError, - :too_many_members => TooManyMembersError, - :too_many_pending_invites => TooManyPendingInvitesError, - :rate_limit => RateLimitError, - :insufficient_plan => InsufficientPlanError, - :team_folder => TeamFolderError, - :no_permission => NoPermissionError + access_error: SharedFolderAccessError, + email_unverified: EmailUnverifiedError, + bad_member: AddMemberSelectorError, + cant_share_outside_team: CantShareOutsideTeamError, + too_many_members: TooManyMembersError, + too_many_pending_invites: TooManyPendingInvitesError, + rate_limit: RateLimitError, + insufficient_plan: InsufficientPlanError, + team_folder: TeamFolderError, + no_permission: NoPermissionError }.freeze end end diff --git a/lib/dropbox_api/errors/add_member_selector_error.rb b/lib/dropbox_api/errors/add_member_selector_error.rb index 2ac82101..14e39c63 100644 --- a/lib/dropbox_api/errors/add_member_selector_error.rb +++ b/lib/dropbox_api/errors/add_member_selector_error.rb @@ -1,11 +1,12 @@ +# frozen_string_literal: true module DropboxApi::Errors class AddMemberSelectorError < BasicError ErrorSubtypes = { - :invalid_dropbox_id => InvalidDropboxIdError, - :invalid_email => InvalidEmailError, - :unverified_dropbox_id => UnverifiedDropboxId, - :group_deleted => GroupDeletedError, - :group_not_on_team => GroupNotOnTeamError + invalid_dropbox_id: InvalidDropboxIdError, + invalid_email: InvalidEmailError, + unverified_dropbox_id: UnverifiedDropboxId, + group_deleted: GroupDeletedError, + group_not_on_team: GroupNotOnTeamError }.freeze end end diff --git a/lib/dropbox_api/errors/already_shared_error.rb b/lib/dropbox_api/errors/already_shared_error.rb index 1a72982c..9cd49b5f 100644 --- a/lib/dropbox_api/errors/already_shared_error.rb +++ b/lib/dropbox_api/errors/already_shared_error.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Errors class AlreadySharedError < BasicError def shared_folder diff --git a/lib/dropbox_api/errors/basic_error.rb b/lib/dropbox_api/errors/basic_error.rb index 3a10be16..127e3cf5 100644 --- a/lib/dropbox_api/errors/basic_error.rb +++ b/lib/dropbox_api/errors/basic_error.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Errors class BasicError < StandardError def initialize(message, metadata) @@ -18,7 +19,7 @@ def build(message, metadata) def find_subtype(metadata) if defined? self::ErrorSubtypes - discriminator = metadata[".tag"] + discriminator = metadata['.tag'] metadata = metadata[discriminator] unless metadata[discriminator].nil? [self::ErrorSubtypes[discriminator.to_sym], metadata] else diff --git a/lib/dropbox_api/errors/create_file_request_error.rb b/lib/dropbox_api/errors/create_file_request_error.rb index 41a76d45..13231366 100644 --- a/lib/dropbox_api/errors/create_file_request_error.rb +++ b/lib/dropbox_api/errors/create_file_request_error.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Errors class CreateFileRequestError < BasicError ErrorSubtypes = { diff --git a/lib/dropbox_api/errors/create_folder_batch_error.rb b/lib/dropbox_api/errors/create_folder_batch_error.rb index eede2399..36747877 100644 --- a/lib/dropbox_api/errors/create_folder_batch_error.rb +++ b/lib/dropbox_api/errors/create_folder_batch_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class CreateFolderBatchError < BasicError ErrorSubtypes = { - :too_many_files => TooManyFilesError + too_many_files: TooManyFilesError }.freeze end end diff --git a/lib/dropbox_api/errors/create_folder_error.rb b/lib/dropbox_api/errors/create_folder_error.rb index 61ce3684..c691fa7f 100644 --- a/lib/dropbox_api/errors/create_folder_error.rb +++ b/lib/dropbox_api/errors/create_folder_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class CreateFolderError < BasicError ErrorSubtypes = { - :path => WriteError + path: WriteError }.freeze end end diff --git a/lib/dropbox_api/errors/create_shared_link_with_settings_error.rb b/lib/dropbox_api/errors/create_shared_link_with_settings_error.rb index a8a0fd89..44ce5081 100644 --- a/lib/dropbox_api/errors/create_shared_link_with_settings_error.rb +++ b/lib/dropbox_api/errors/create_shared_link_with_settings_error.rb @@ -1,11 +1,12 @@ +# frozen_string_literal: true module DropboxApi::Errors class CreateSharedLinkWithSettingsError < BasicError ErrorSubtypes = { - :path => LookupError, - :email_not_verified => EmailUnverifiedError, - :shared_link_already_exists => SharedLinkAlreadyExistsError, - :settings_error => SettingsError, - :access_denied => NoPermissionError + path: LookupError, + email_not_verified: EmailUnverifiedError, + shared_link_already_exists: SharedLinkAlreadyExistsError, + settings_error: SettingsError, + access_denied: NoPermissionError }.freeze end end diff --git a/lib/dropbox_api/errors/delete_error.rb b/lib/dropbox_api/errors/delete_error.rb index aa4a9556..6179cf37 100644 --- a/lib/dropbox_api/errors/delete_error.rb +++ b/lib/dropbox_api/errors/delete_error.rb @@ -1,9 +1,10 @@ +# frozen_string_literal: true module DropboxApi::Errors class DeleteError < BasicError ErrorSubtypes = { - :path_lookup => LookupError, - :path_write => WriteError, - :too_many_write_operations => TooManyWriteOperationsError + path_lookup: LookupError, + path_write: WriteError, + too_many_write_operations: TooManyWriteOperationsError }.freeze end end \ No newline at end of file diff --git a/lib/dropbox_api/errors/download_error.rb b/lib/dropbox_api/errors/download_error.rb index 5e5555ec..296ba32e 100644 --- a/lib/dropbox_api/errors/download_error.rb +++ b/lib/dropbox_api/errors/download_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class DownloadError < BasicError ErrorSubtypes = { - :path => LookupError + path: LookupError }.freeze end end diff --git a/lib/dropbox_api/errors/expired_access_token_error.rb b/lib/dropbox_api/errors/expired_access_token_error.rb new file mode 100644 index 00000000..15dc04fa --- /dev/null +++ b/lib/dropbox_api/errors/expired_access_token_error.rb @@ -0,0 +1,5 @@ +# frozen_string_literal: true +module DropboxApi::Errors + class ExpiredAccessTokenError < BasicError + end +end diff --git a/lib/dropbox_api/errors/file_member_action_error.rb b/lib/dropbox_api/errors/file_member_action_error.rb index 63227e52..a1457ac1 100644 --- a/lib/dropbox_api/errors/file_member_action_error.rb +++ b/lib/dropbox_api/errors/file_member_action_error.rb @@ -1,10 +1,11 @@ +# frozen_string_literal: true module DropboxApi::Errors class FileMemberActionError < BasicError ErrorSubtypes = { - :invalid_member => InvalidMemberError, - :no_permission => NoPermissionError, - :access_error => SharingFileAccessError, - :no_explicit_access => DropboxApi::Metadata::ParentFolderAccessInfo + invalid_member: InvalidMemberError, + no_permission: NoPermissionError, + access_error: SharingFileAccessError, + no_explicit_access: DropboxApi::Metadata::ParentFolderAccessInfo }.freeze end end diff --git a/lib/dropbox_api/errors/get_account_error.rb b/lib/dropbox_api/errors/get_account_error.rb index 43075d8b..5f373a2c 100644 --- a/lib/dropbox_api/errors/get_account_error.rb +++ b/lib/dropbox_api/errors/get_account_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class GetAccountError < BasicError ErrorSubtypes = { - :no_account => NoAccountError + no_account: NoAccountError }.freeze end end diff --git a/lib/dropbox_api/errors/get_copy_reference_error.rb b/lib/dropbox_api/errors/get_copy_reference_error.rb index d36a14c0..f6ed8641 100644 --- a/lib/dropbox_api/errors/get_copy_reference_error.rb +++ b/lib/dropbox_api/errors/get_copy_reference_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class GetCopyReferenceError < BasicError ErrorSubtypes = { - :path => LookupError + path: LookupError }.freeze end end diff --git a/lib/dropbox_api/errors/get_metadata_error.rb b/lib/dropbox_api/errors/get_metadata_error.rb index ea909599..db39757f 100644 --- a/lib/dropbox_api/errors/get_metadata_error.rb +++ b/lib/dropbox_api/errors/get_metadata_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class GetMetadataError < BasicError ErrorSubtypes = { - :path => LookupError + path: LookupError }.freeze end end diff --git a/lib/dropbox_api/errors/http_error.rb b/lib/dropbox_api/errors/http_error.rb index 9e39d1fb..93f44422 100644 --- a/lib/dropbox_api/errors/http_error.rb +++ b/lib/dropbox_api/errors/http_error.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi module Errors class HttpError < StandardError diff --git a/lib/dropbox_api/errors/list_folder_continue_error.rb b/lib/dropbox_api/errors/list_folder_continue_error.rb index 3b7fc02c..079d12b9 100644 --- a/lib/dropbox_api/errors/list_folder_continue_error.rb +++ b/lib/dropbox_api/errors/list_folder_continue_error.rb @@ -1,8 +1,9 @@ +# frozen_string_literal: true module DropboxApi::Errors class ListFolderContinueError < BasicError ErrorSubtypes = { - :path => WriteError, - :reset => InvalidCursorError + path: WriteError, + reset: InvalidCursorError }.freeze end end diff --git a/lib/dropbox_api/errors/list_folder_error.rb b/lib/dropbox_api/errors/list_folder_error.rb index 2fb7ef23..a48e4a39 100644 --- a/lib/dropbox_api/errors/list_folder_error.rb +++ b/lib/dropbox_api/errors/list_folder_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class ListFolderError < BasicError ErrorSubtypes = { - :path => LookupError + path: LookupError }.freeze end end diff --git a/lib/dropbox_api/errors/list_folder_longpoll_error.rb b/lib/dropbox_api/errors/list_folder_longpoll_error.rb index 34ca9fb6..ad835f93 100644 --- a/lib/dropbox_api/errors/list_folder_longpoll_error.rb +++ b/lib/dropbox_api/errors/list_folder_longpoll_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class ListFolderLongpollError < BasicError ErrorSubtypes = { - :reset => InvalidCursorError + reset: InvalidCursorError }.freeze end end diff --git a/lib/dropbox_api/errors/list_revisions_error.rb b/lib/dropbox_api/errors/list_revisions_error.rb index 27d6ec92..9bc5c9b1 100644 --- a/lib/dropbox_api/errors/list_revisions_error.rb +++ b/lib/dropbox_api/errors/list_revisions_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class ListRevisionsError < BasicError ErrorSubtypes = { - :path => LookupError + path: LookupError }.freeze end end diff --git a/lib/dropbox_api/errors/list_shared_links_error.rb b/lib/dropbox_api/errors/list_shared_links_error.rb index 1b0c47b2..6bd0991e 100644 --- a/lib/dropbox_api/errors/list_shared_links_error.rb +++ b/lib/dropbox_api/errors/list_shared_links_error.rb @@ -1,8 +1,9 @@ +# frozen_string_literal: true module DropboxApi::Errors class ListSharedLinksError < BasicError ErrorSubtypes = { - :path => LookupError, - :reset => InvalidCursorError + path: LookupError, + reset: InvalidCursorError }.freeze end end diff --git a/lib/dropbox_api/errors/lookup_error.rb b/lib/dropbox_api/errors/lookup_error.rb index 4f024fe6..465b05be 100644 --- a/lib/dropbox_api/errors/lookup_error.rb +++ b/lib/dropbox_api/errors/lookup_error.rb @@ -1,11 +1,12 @@ +# frozen_string_literal: true module DropboxApi::Errors class LookupError < BasicError ErrorSubtypes = { - :malformed_path => MalformedPathError, - :not_found => NotFoundError, - :not_file => NotFileError, - :not_folder => NotFolderError, - :restricted_content => RestrictedContentError + malformed_path: MalformedPathError, + not_found: NotFoundError, + not_file: NotFileError, + not_folder: NotFolderError, + restricted_content: RestrictedContentError }.freeze end end diff --git a/lib/dropbox_api/errors/poll_error.rb b/lib/dropbox_api/errors/poll_error.rb index 747a1bee..a9114e79 100644 --- a/lib/dropbox_api/errors/poll_error.rb +++ b/lib/dropbox_api/errors/poll_error.rb @@ -1,8 +1,9 @@ +# frozen_string_literal: true module DropboxApi::Errors class PollError < BasicError ErrorSubtypes = { - :invalid_async_job_id => InvalidIdError, - :internal_error => InternalError + invalid_async_job_id: InvalidIdError, + internal_error: InternalError }.freeze end end diff --git a/lib/dropbox_api/errors/preview_error.rb b/lib/dropbox_api/errors/preview_error.rb index 87c21ca6..c626fe6c 100644 --- a/lib/dropbox_api/errors/preview_error.rb +++ b/lib/dropbox_api/errors/preview_error.rb @@ -1,10 +1,11 @@ +# frozen_string_literal: true module DropboxApi::Errors class PreviewError < BasicError ErrorSubtypes = { - :path => LookupError, - :in_progress => InProgressError, - :unsupported_extension => UnsupportedExtensionError, - :unsupported_content => UnsupportedContentError + path: LookupError, + in_progress: InProgressError, + unsupported_extension: UnsupportedExtensionError, + unsupported_content: UnsupportedContentError }.freeze end end diff --git a/lib/dropbox_api/errors/relocation_batch_entry_error.rb b/lib/dropbox_api/errors/relocation_batch_entry_error.rb index 041746de..b3aa4be8 100644 --- a/lib/dropbox_api/errors/relocation_batch_entry_error.rb +++ b/lib/dropbox_api/errors/relocation_batch_entry_error.rb @@ -1,9 +1,10 @@ +# frozen_string_literal: true module DropboxApi::Errors class RelocationBatchEntryError < BasicError ErrorSubtypes = { - :relocation_error => RelocationError, - :internal_error => InternalError, - :too_many_write_operations => TooManyWriteOperationsError + relocation_error: RelocationError, + internal_error: InternalError, + too_many_write_operations: TooManyWriteOperationsError }.freeze end end \ No newline at end of file diff --git a/lib/dropbox_api/errors/relocation_error.rb b/lib/dropbox_api/errors/relocation_error.rb index b3fe41f1..21be4e39 100644 --- a/lib/dropbox_api/errors/relocation_error.rb +++ b/lib/dropbox_api/errors/relocation_error.rb @@ -1,13 +1,14 @@ +# frozen_string_literal: true module DropboxApi::Errors class RelocationError < BasicError ErrorSubtypes = { - :from_lookup => LookupError, - :from_write => WriteError, - :to => WriteError, - :cant_copy_shared_folder => CantCopySharedFolderError, - :cant_nest_shared_folder => CantNestSharedFolderError, - :cant_move_folder_into_itself => CantMoveFolderIntoItselfError, - :too_many_files => TooManyFilesError + from_lookup: LookupError, + from_write: WriteError, + to: WriteError, + cant_copy_shared_folder: CantCopySharedFolderError, + cant_nest_shared_folder: CantNestSharedFolderError, + cant_move_folder_into_itself: CantMoveFolderIntoItselfError, + too_many_files: TooManyFilesError }.freeze end end diff --git a/lib/dropbox_api/errors/restore_error.rb b/lib/dropbox_api/errors/restore_error.rb index 97c05222..bba5909a 100644 --- a/lib/dropbox_api/errors/restore_error.rb +++ b/lib/dropbox_api/errors/restore_error.rb @@ -1,9 +1,10 @@ +# frozen_string_literal: true module DropboxApi::Errors class RestoreError < BasicError ErrorSubtypes = { - :path_lookup => LookupError, - :path_write => WriteError, - :invalid_revision => InvalidRevisionError + path_lookup: LookupError, + path_write: WriteError, + invalid_revision: InvalidRevisionError }.freeze end end diff --git a/lib/dropbox_api/errors/revoke_shared_link_error.rb b/lib/dropbox_api/errors/revoke_shared_link_error.rb index de88e51d..307cc38a 100644 --- a/lib/dropbox_api/errors/revoke_shared_link_error.rb +++ b/lib/dropbox_api/errors/revoke_shared_link_error.rb @@ -1,10 +1,11 @@ +# frozen_string_literal: true module DropboxApi::Errors class RevokeSharedLinkError < BasicError ErrorSubtypes = { - :shared_link_not_found => SharedLinkNotFoundError, - :shared_link_access_denied => SharedLinkAccessDeniedError, - :unsupported_link_type => UnsupportedLinkTypeError, - :shared_link_malformed => SharedLinkMalformedError + shared_link_not_found: SharedLinkNotFoundError, + shared_link_access_denied: SharedLinkAccessDeniedError, + unsupported_link_type: UnsupportedLinkTypeError, + shared_link_malformed: SharedLinkMalformedError }.freeze end end \ No newline at end of file diff --git a/lib/dropbox_api/errors/save_copy_reference_error.rb b/lib/dropbox_api/errors/save_copy_reference_error.rb index 658b6d46..5aac7d2e 100644 --- a/lib/dropbox_api/errors/save_copy_reference_error.rb +++ b/lib/dropbox_api/errors/save_copy_reference_error.rb @@ -1,11 +1,12 @@ +# frozen_string_literal: true module DropboxApi::Errors class SaveCopyReferenceError < BasicError ErrorSubtypes = { - :path => WriteError, - :invalid_copy_reference => InvalidCopyReferenceError, - :no_permission => NoPermissionError, - :not_found => NotFoundError, - :too_many_files => TooManyFilesError + path: WriteError, + invalid_copy_reference: InvalidCopyReferenceError, + no_permission: NoPermissionError, + not_found: NotFoundError, + too_many_files: TooManyFilesError }.freeze end end diff --git a/lib/dropbox_api/errors/save_url_error.rb b/lib/dropbox_api/errors/save_url_error.rb index fc5ea296..644301b8 100644 --- a/lib/dropbox_api/errors/save_url_error.rb +++ b/lib/dropbox_api/errors/save_url_error.rb @@ -1,10 +1,11 @@ +# frozen_string_literal: true module DropboxApi::Errors class SaveUrlError < BasicError ErrorSubtypes = { - :path => WriteError, - :download_failed => DownloadFailedError, - :invalid_url => InvalidUrlError, - :not_found => NotFoundError + path: WriteError, + download_failed: DownloadFailedError, + invalid_url: InvalidUrlError, + not_found: NotFoundError }.freeze end end diff --git a/lib/dropbox_api/errors/search_error.rb b/lib/dropbox_api/errors/search_error.rb index 4f804861..ed60211d 100644 --- a/lib/dropbox_api/errors/search_error.rb +++ b/lib/dropbox_api/errors/search_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class SearchError < BasicError ErrorSubtypes = { - :path => LookupError + path: LookupError }.freeze end end diff --git a/lib/dropbox_api/errors/settings_error.rb b/lib/dropbox_api/errors/settings_error.rb index 7ae1a9df..73c39e31 100644 --- a/lib/dropbox_api/errors/settings_error.rb +++ b/lib/dropbox_api/errors/settings_error.rb @@ -1,8 +1,9 @@ +# frozen_string_literal: true module DropboxApi::Errors class SettingsError < BasicError ErrorSubtypes = { - :invalid_settings => InvalidSettingsError, - :not_authorized => NoPermissionError + invalid_settings: InvalidSettingsError, + not_authorized: NoPermissionError }.freeze end end diff --git a/lib/dropbox_api/errors/share_folder_error.rb b/lib/dropbox_api/errors/share_folder_error.rb index 007dc47f..a08277d3 100644 --- a/lib/dropbox_api/errors/share_folder_error.rb +++ b/lib/dropbox_api/errors/share_folder_error.rb @@ -1,11 +1,12 @@ +# frozen_string_literal: true module DropboxApi::Errors class ShareFolderError < BasicError ErrorSubtypes = { - :email_unverified => EmailUnverifiedError, - :bad_path => SharePathError, - :team_policy_disallows_member_policy => TeamPolicyDisallowsMemberPolicyError, - :disallowed_shared_link_policy => DisallowedSharedLinkPolicyError, - :no_permission => NoPermissionError + email_unverified: EmailUnverifiedError, + bad_path: SharePathError, + team_policy_disallows_member_policy: TeamPolicyDisallowsMemberPolicyError, + disallowed_shared_link_policy: DisallowedSharedLinkPolicyError, + no_permission: NoPermissionError }.freeze end end diff --git a/lib/dropbox_api/errors/share_path_error.rb b/lib/dropbox_api/errors/share_path_error.rb index dc76ed41..92672b86 100644 --- a/lib/dropbox_api/errors/share_path_error.rb +++ b/lib/dropbox_api/errors/share_path_error.rb @@ -1,17 +1,18 @@ +# frozen_string_literal: true module DropboxApi::Errors class SharePathError < BasicError ErrorSubtypes = { - :is_file => IsFileError, - :inside_shared_folder => InsideSharedFolderError, - :contains_shared_folder => ContainsSharedFolderError, - :is_app_folder => IsAppFolderError, - :inside_app_folder => InsideAppFolderError, - :is_public_folder => IsPublicFolderError, - :inside_public_folder => InsidePublicFolderError, - :already_shared => AlreadySharedError, - :invalid_path => InvalidPathError, - :is_osx_package => IsOsxPackageError, - :inside_osx_package => InsideOsxPackageError, + is_file: IsFileError, + inside_shared_folder: InsideSharedFolderError, + contains_shared_folder: ContainsSharedFolderError, + is_app_folder: IsAppFolderError, + inside_app_folder: InsideAppFolderError, + is_public_folder: IsPublicFolderError, + inside_public_folder: InsidePublicFolderError, + already_shared: AlreadySharedError, + invalid_path: InvalidPathError, + is_osx_package: IsOsxPackageError, + inside_osx_package: InsideOsxPackageError, }.freeze end end diff --git a/lib/dropbox_api/errors/shared_folder_access_error.rb b/lib/dropbox_api/errors/shared_folder_access_error.rb index de4d6619..a3706c06 100644 --- a/lib/dropbox_api/errors/shared_folder_access_error.rb +++ b/lib/dropbox_api/errors/shared_folder_access_error.rb @@ -1,10 +1,11 @@ +# frozen_string_literal: true module DropboxApi::Errors class SharedFolderAccessError < BasicError ErrorSubtypes = { - :invalid_id => InvalidIdError, - :not_a_member => NotAMemberError, - :email_unverified => EmailUnverifiedError, - :unmounted => UnmountedError + invalid_id: InvalidIdError, + not_a_member: NotAMemberError, + email_unverified: EmailUnverifiedError, + unmounted: UnmountedError }.freeze end end diff --git a/lib/dropbox_api/errors/shared_link_error.rb b/lib/dropbox_api/errors/shared_link_error.rb index 5a28c746..2485b304 100644 --- a/lib/dropbox_api/errors/shared_link_error.rb +++ b/lib/dropbox_api/errors/shared_link_error.rb @@ -1,9 +1,10 @@ +# frozen_string_literal: true module DropboxApi::Errors class SharedLinkError < BasicError ErrorSubtypes = { - :shared_link_not_found => SharedLinkNotFoundError, - :shared_link_access_denied => SharedLinkAccessDeniedError, - :unsupported_link_type => UnsupportedLinkTypeError + shared_link_not_found: SharedLinkNotFoundError, + shared_link_access_denied: SharedLinkAccessDeniedError, + unsupported_link_type: UnsupportedLinkTypeError }.freeze end end diff --git a/lib/dropbox_api/errors/sharing_file_access_error.rb b/lib/dropbox_api/errors/sharing_file_access_error.rb index fba0b1bc..8aa01dbb 100644 --- a/lib/dropbox_api/errors/sharing_file_access_error.rb +++ b/lib/dropbox_api/errors/sharing_file_access_error.rb @@ -1,11 +1,12 @@ +# frozen_string_literal: true module DropboxApi::Errors class SharingFileAccessError < BasicError ErrorSubtypes = { - :no_permission => NoPermissionError, - :invalid_file => InvalidFileError, - :is_folder => IsFolderError, - :inside_public_folder => InsidePublicFolderError, - :inside_osx_package => InsideOsxPackageError + no_permission: NoPermissionError, + invalid_file: InvalidFileError, + is_folder: IsFolderError, + inside_public_folder: InsidePublicFolderError, + inside_osx_package: InsideOsxPackageError }.freeze end end diff --git a/lib/dropbox_api/errors/sharing_user_error.rb b/lib/dropbox_api/errors/sharing_user_error.rb index 0155bf06..4141c78c 100644 --- a/lib/dropbox_api/errors/sharing_user_error.rb +++ b/lib/dropbox_api/errors/sharing_user_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class SharingUserError < BasicError ErrorSubtypes = { - :email_unverified => EmailUnverifiedError + email_unverified: EmailUnverifiedError }.freeze end end diff --git a/lib/dropbox_api/errors/thumbnail_batch_error.rb b/lib/dropbox_api/errors/thumbnail_batch_error.rb index 0a2807e2..567c7036 100644 --- a/lib/dropbox_api/errors/thumbnail_batch_error.rb +++ b/lib/dropbox_api/errors/thumbnail_batch_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class ThumbnailBatchError < BasicError ErrorSubtypes = { - :too_many_files => TooManyFilesError + too_many_files: TooManyFilesError }.freeze end end diff --git a/lib/dropbox_api/errors/thumbnail_error.rb b/lib/dropbox_api/errors/thumbnail_error.rb index 325a0a6c..fa427a0e 100644 --- a/lib/dropbox_api/errors/thumbnail_error.rb +++ b/lib/dropbox_api/errors/thumbnail_error.rb @@ -1,10 +1,11 @@ +# frozen_string_literal: true module DropboxApi::Errors class ThumbnailError < BasicError ErrorSubtypes = { - :path => LookupError, - :unsupported_extension => UnsupportedExtensionError, - :unsupported_image => UnsupportedImageError, - :conversion_error => ConversionError + path: LookupError, + unsupported_extension: UnsupportedExtensionError, + unsupported_image: UnsupportedImageError, + conversion_error: ConversionError }.freeze end end diff --git a/lib/dropbox_api/errors/too_many_requests_error.rb b/lib/dropbox_api/errors/too_many_requests_error.rb index 29ba85f1..32b9ef60 100644 --- a/lib/dropbox_api/errors/too_many_requests_error.rb +++ b/lib/dropbox_api/errors/too_many_requests_error.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Errors class TooManyRequestsError < BasicError; end class TooManyWriteOperationsError < TooManyRequestsError; end @@ -12,8 +13,8 @@ def self.build(message, metadata) end ErrorSubtypes = { - :too_many_requests => TooManyRequestsError, - :too_many_write_operations => TooManyWriteOperationsError + too_many_requests: TooManyRequestsError, + too_many_write_operations: TooManyWriteOperationsError } end end diff --git a/lib/dropbox_api/errors/unshare_file_error.rb b/lib/dropbox_api/errors/unshare_file_error.rb index ab212bbd..5271b567 100644 --- a/lib/dropbox_api/errors/unshare_file_error.rb +++ b/lib/dropbox_api/errors/unshare_file_error.rb @@ -1,8 +1,9 @@ +# frozen_string_literal: true module DropboxApi::Errors class UnshareFileError < BasicError ErrorSubtypes = { - :user_error => SharingUserError, - :access_error => SharingFileAccessError + user_error: SharingUserError, + access_error: SharingFileAccessError }.freeze end end diff --git a/lib/dropbox_api/errors/upload_error.rb b/lib/dropbox_api/errors/upload_error.rb index d3b20294..e0bf63e2 100644 --- a/lib/dropbox_api/errors/upload_error.rb +++ b/lib/dropbox_api/errors/upload_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class UploadError < BasicError ErrorSubtypes = { - :path => UploadWriteFailedError + path: UploadWriteFailedError }.freeze end end diff --git a/lib/dropbox_api/errors/upload_session_finish_error.rb b/lib/dropbox_api/errors/upload_session_finish_error.rb index 86d2c665..af2a36b8 100644 --- a/lib/dropbox_api/errors/upload_session_finish_error.rb +++ b/lib/dropbox_api/errors/upload_session_finish_error.rb @@ -1,9 +1,10 @@ +# frozen_string_literal: true module DropboxApi::Errors class UploadSessionFinishError < BasicError ErrorSubtypes = { - :lookup_failed => UploadSessionLookupError, - :path => WriteError, - :too_many_shared_folder_targets => TooManySharedFolderTargetsError + lookup_failed: UploadSessionLookupError, + path: WriteError, + too_many_shared_folder_targets: TooManySharedFolderTargetsError }.freeze end end diff --git a/lib/dropbox_api/errors/upload_session_lookup_error.rb b/lib/dropbox_api/errors/upload_session_lookup_error.rb index ec74d15c..ee801c06 100644 --- a/lib/dropbox_api/errors/upload_session_lookup_error.rb +++ b/lib/dropbox_api/errors/upload_session_lookup_error.rb @@ -1,10 +1,11 @@ +# frozen_string_literal: true module DropboxApi::Errors class UploadSessionLookupError < BasicError ErrorSubtypes = { - :not_found => NotFoundError, - :incorrect_offset => UploadSessionOffsetError, - :closed => CursorClosedError, - :not_closed => CursorNotClosedError + not_found: NotFoundError, + incorrect_offset: UploadSessionOffsetError, + closed: CursorClosedError, + not_closed: CursorNotClosedError }.freeze end end diff --git a/lib/dropbox_api/errors/upload_session_offset_error.rb b/lib/dropbox_api/errors/upload_session_offset_error.rb index de32b704..10bf4384 100644 --- a/lib/dropbox_api/errors/upload_session_offset_error.rb +++ b/lib/dropbox_api/errors/upload_session_offset_error.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Errors class UploadSessionOffsetError < BasicError def initialize(message, metadata) diff --git a/lib/dropbox_api/errors/upload_write_failed_error.rb b/lib/dropbox_api/errors/upload_write_failed_error.rb index a8db59ea..3dad7f76 100644 --- a/lib/dropbox_api/errors/upload_write_failed_error.rb +++ b/lib/dropbox_api/errors/upload_write_failed_error.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Errors class UploadWriteFailedError < BasicError ErrorSubtypes = { - :reason => WriteError + reason: WriteError }.freeze end end diff --git a/lib/dropbox_api/errors/write_conflict_error.rb b/lib/dropbox_api/errors/write_conflict_error.rb index 902f60c6..ae231c17 100644 --- a/lib/dropbox_api/errors/write_conflict_error.rb +++ b/lib/dropbox_api/errors/write_conflict_error.rb @@ -1,9 +1,10 @@ +# frozen_string_literal: true module DropboxApi::Errors class WriteConflictError < BasicError ErrorSubtypes = { - :file => FileConflictError, - :folder => FolderConflictError, - :file_ancestor => FileAncestorConflictError + file: FileConflictError, + folder: FolderConflictError, + file_ancestor: FileAncestorConflictError } end end diff --git a/lib/dropbox_api/errors/write_error.rb b/lib/dropbox_api/errors/write_error.rb index 88366308..c243ffe6 100644 --- a/lib/dropbox_api/errors/write_error.rb +++ b/lib/dropbox_api/errors/write_error.rb @@ -1,11 +1,12 @@ +# frozen_string_literal: true module DropboxApi::Errors class WriteError < BasicError ErrorSubtypes = { - :malformed_path => MalformedPathError, - :conflict => WriteConflictError, - :no_write_permission => NoWritePermissionError, - :insufficient_space => InsufficientSpaceError, - :disallowed_name => DisallowedNameError + malformed_path: MalformedPathError, + conflict: WriteConflictError, + no_write_permission: NoWritePermissionError, + insufficient_space: InsufficientSpaceError, + disallowed_name: DisallowedNameError } end end diff --git a/lib/dropbox_api/metadata/access_level.rb b/lib/dropbox_api/metadata/access_level.rb index f3cbcd5f..c9bf9568 100644 --- a/lib/dropbox_api/metadata/access_level.rb +++ b/lib/dropbox_api/metadata/access_level.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {AccessLevel} object: # diff --git a/lib/dropbox_api/metadata/add_file_member_result.rb b/lib/dropbox_api/metadata/add_file_member_result.rb index 3628e191..0d2f254b 100644 --- a/lib/dropbox_api/metadata/add_file_member_result.rb +++ b/lib/dropbox_api/metadata/add_file_member_result.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a {AddFileMemberResult}: # diff --git a/lib/dropbox_api/metadata/add_member.rb b/lib/dropbox_api/metadata/add_member.rb index 9d377e24..7266c0a7 100644 --- a/lib/dropbox_api/metadata/add_member.rb +++ b/lib/dropbox_api/metadata/add_member.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Examples of serialized {AddMember} objects: # @@ -25,8 +26,8 @@ class AddMember < Base class << self def build_from_string(member, access_level = :editor) new({ - "member" => Member.new(member), - "access_level" => access_level + 'member' => Member.new(member), + 'access_level' => access_level }) end end diff --git a/lib/dropbox_api/metadata/base.rb b/lib/dropbox_api/metadata/base.rb index 255d3639..55d277ad 100644 --- a/lib/dropbox_api/metadata/base.rb +++ b/lib/dropbox_api/metadata/base.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata class Base class << self @@ -46,7 +47,7 @@ def serialized_field(field_name) value = send field_name case value when Time - value.utc.strftime("%FT%TZ") + value.utc.strftime('%FT%TZ') when DropboxApi::Metadata::Base value.to_hash else diff --git a/lib/dropbox_api/metadata/basic_account.rb b/lib/dropbox_api/metadata/basic_account.rb index 8b736fef..05875bb1 100644 --- a/lib/dropbox_api/metadata/basic_account.rb +++ b/lib/dropbox_api/metadata/basic_account.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {BasicAccount} object: # @@ -15,7 +16,12 @@ module DropboxApi::Metadata # "disabled": false, # "is_teammate": true, # "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbid%3AAAH4f99T0taONIb-OurWxbNQ6ywGRopQngc?vers=1453416696524&size=128x128", - # "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU" + # "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU", + # "root_info": { + # root_namespace_id: 7, + # home_namespace_id: 1, + # home_path: "/Franz Ferdinand" + # } # } # ``` class BasicAccount < Base @@ -27,5 +33,6 @@ class BasicAccount < Base field :is_teammate, :boolean, :optional field :profile_photo_url, String, :optional field :team_member_id, :boolean, :optional + field :root_info, DropboxApi::Metadata::RootInfo, :optional end end diff --git a/lib/dropbox_api/metadata/commit_info.rb b/lib/dropbox_api/metadata/commit_info.rb index d7cf4edc..fa166108 100644 --- a/lib/dropbox_api/metadata/commit_info.rb +++ b/lib/dropbox_api/metadata/commit_info.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata class CommitInfo < Base field :path, String @@ -36,7 +37,7 @@ def build_write_mode(write_mode) end def build_client_modified(client_modified) - client_modified.utc.strftime("%FT%TZ") + client_modified.utc.strftime('%FT%TZ') end end end diff --git a/lib/dropbox_api/metadata/deleted.rb b/lib/dropbox_api/metadata/deleted.rb index b324d895..9832832e 100644 --- a/lib/dropbox_api/metadata/deleted.rb +++ b/lib/dropbox_api/metadata/deleted.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {Deleted} object: # diff --git a/lib/dropbox_api/metadata/dimensions.rb b/lib/dropbox_api/metadata/dimensions.rb index 57370d9c..4091f131 100644 --- a/lib/dropbox_api/metadata/dimensions.rb +++ b/lib/dropbox_api/metadata/dimensions.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata class Dimensions < Base field :height, Integer diff --git a/lib/dropbox_api/metadata/field.rb b/lib/dropbox_api/metadata/field.rb index a395d0da..c9567f76 100644 --- a/lib/dropbox_api/metadata/field.rb +++ b/lib/dropbox_api/metadata/field.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata class Field def initialize(type, options = []) @@ -24,13 +25,15 @@ def force_cast(object) elsif @type == Float object.to_f elsif @type == Symbol - object[".tag"].to_sym + object['.tag'].to_sym elsif @type == :boolean - object.to_s == "true" - elsif @type.ancestors.include? DropboxApi::Metadata::Base + object.to_s == 'true' + elsif @type.ancestors.include?(DropboxApi::Metadata::Base) || + @type.ancestors.include?(Array) || + @type == DropboxApi::Metadata::Resource @type.new(object) else - raise NotImplementedError, "Can't cast `#{@type}`" + raise NotImplementedError, "Can't cast #{object} to `#{@type}`" end end end diff --git a/lib/dropbox_api/metadata/file.rb b/lib/dropbox_api/metadata/file.rb index f5e381c2..909844d2 100644 --- a/lib/dropbox_api/metadata/file.rb +++ b/lib/dropbox_api/metadata/file.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {File} object: # @@ -33,7 +34,7 @@ class File < Base field :has_explicit_shared_members, :boolean, :optional def to_hash - super.merge(".tag" => "file") + super.merge('.tag' => 'file') end end end diff --git a/lib/dropbox_api/metadata/file_categories_list.rb b/lib/dropbox_api/metadata/file_categories_list.rb new file mode 100644 index 00000000..2a2bdae4 --- /dev/null +++ b/lib/dropbox_api/metadata/file_categories_list.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +module DropboxApi::Metadata + class FileCategoriesList < Array + def initialize(list) + super(list.map { |c| DropboxApi::Metadata::FileCategory.new c }) + end + end +end diff --git a/lib/dropbox_api/metadata/file_category.rb b/lib/dropbox_api/metadata/file_category.rb new file mode 100644 index 00000000..a15ffd83 --- /dev/null +++ b/lib/dropbox_api/metadata/file_category.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module DropboxApi::Metadata + class FileCategory < DropboxApi::Metadata::Tag + VALID_VALUES = %i[ + image + document + pdf + spreadsheet + presentation + audio + video + folder + paper + others + ].freeze + + def self.valid_values + VALID_VALUES + end + end +end diff --git a/lib/dropbox_api/metadata/file_extensions_list.rb b/lib/dropbox_api/metadata/file_extensions_list.rb new file mode 100644 index 00000000..218465b5 --- /dev/null +++ b/lib/dropbox_api/metadata/file_extensions_list.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +module DropboxApi::Metadata + class FileExtensionsList < Array + def initialize(data) + if !data.is_a?(Array) || data.any? { |v| !v.is_a? String } + raise ArgumentError, "Invalid extension list: #{data.inspect}." + end + + super(data) + end + end +end diff --git a/lib/dropbox_api/metadata/file_link_metadata.rb b/lib/dropbox_api/metadata/file_link_metadata.rb index c68d24a4..e954283a 100644 --- a/lib/dropbox_api/metadata/file_link_metadata.rb +++ b/lib/dropbox_api/metadata/file_link_metadata.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {FileLinkMetadata} object: # diff --git a/lib/dropbox_api/metadata/file_member_action.rb b/lib/dropbox_api/metadata/file_member_action.rb index 85dfdd10..0141de7d 100644 --- a/lib/dropbox_api/metadata/file_member_action.rb +++ b/lib/dropbox_api/metadata/file_member_action.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized FileMemberAction: # @@ -12,7 +13,7 @@ module DropboxApi::Metadata class FileMemberAction < Base class << self def new(data) - tag = data[".tag"] + tag = data['.tag'] class_for(tag.to_sym).new(data[tag]) end diff --git a/lib/dropbox_api/metadata/file_request.rb b/lib/dropbox_api/metadata/file_request.rb index 15fa988c..3cd0bd41 100644 --- a/lib/dropbox_api/metadata/file_request.rb +++ b/lib/dropbox_api/metadata/file_request.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {FileRequest} object: # diff --git a/lib/dropbox_api/metadata/file_status.rb b/lib/dropbox_api/metadata/file_status.rb new file mode 100644 index 00000000..b04fe8e1 --- /dev/null +++ b/lib/dropbox_api/metadata/file_status.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module DropboxApi::Metadata + class FileStatus < DropboxApi::Metadata::Tag + VALID_VALUES = %i[ + active + deleted + ].freeze + + def self.valid_values + VALID_VALUES + end + end +end diff --git a/lib/dropbox_api/metadata/folder.rb b/lib/dropbox_api/metadata/folder.rb index 1d15cd20..e2c78dbe 100644 --- a/lib/dropbox_api/metadata/folder.rb +++ b/lib/dropbox_api/metadata/folder.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {Folder} object: # @@ -17,7 +18,7 @@ class Folder < Base field :sharing_info, DropboxApi::Metadata::FolderSharingInfo, :optional def to_hash - super.merge(".tag" => "folder") + super.merge('.tag' => 'folder') end end end diff --git a/lib/dropbox_api/metadata/folder_link_metadata.rb b/lib/dropbox_api/metadata/folder_link_metadata.rb index 308de244..488690e2 100644 --- a/lib/dropbox_api/metadata/folder_link_metadata.rb +++ b/lib/dropbox_api/metadata/folder_link_metadata.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata class FolderLinkMetadata < Base field :url, String diff --git a/lib/dropbox_api/metadata/folder_sharing_info.rb b/lib/dropbox_api/metadata/folder_sharing_info.rb index 2cbe85ba..9bb3f2ed 100644 --- a/lib/dropbox_api/metadata/folder_sharing_info.rb +++ b/lib/dropbox_api/metadata/folder_sharing_info.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {FolderSharingInfo} object: # diff --git a/lib/dropbox_api/metadata/link_permissions.rb b/lib/dropbox_api/metadata/link_permissions.rb index f9ad6160..541294d3 100644 --- a/lib/dropbox_api/metadata/link_permissions.rb +++ b/lib/dropbox_api/metadata/link_permissions.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {LinkPermissions} object: # diff --git a/lib/dropbox_api/metadata/location.rb b/lib/dropbox_api/metadata/location.rb index fe35763b..d1f6b964 100644 --- a/lib/dropbox_api/metadata/location.rb +++ b/lib/dropbox_api/metadata/location.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata class Location < Base field :latitude, Float diff --git a/lib/dropbox_api/metadata/media_info.rb b/lib/dropbox_api/metadata/media_info.rb index 3ef7aeb4..ca544c28 100644 --- a/lib/dropbox_api/metadata/media_info.rb +++ b/lib/dropbox_api/metadata/media_info.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {MediaInfo} object: # diff --git a/lib/dropbox_api/metadata/media_metadata.rb b/lib/dropbox_api/metadata/media_metadata.rb index 3e122f2a..eb02f4ca 100644 --- a/lib/dropbox_api/metadata/media_metadata.rb +++ b/lib/dropbox_api/metadata/media_metadata.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {MediaInfo} object: # diff --git a/lib/dropbox_api/metadata/member.rb b/lib/dropbox_api/metadata/member.rb index 75941969..e637ac3a 100644 --- a/lib/dropbox_api/metadata/member.rb +++ b/lib/dropbox_api/metadata/member.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Examples of serialized {AddMember} objects: # @@ -33,7 +34,7 @@ def to_hash private def hash_from_email_or_dropbox_id(email_or_id) - if email_or_id.start_with? "dbid:" + if email_or_id.start_with? 'dbid:' hash_from_dropbox_id email_or_id elsif email_or_id =~ /\A[^@\s]+@[^@\s]+\z/ hash_from_email email_or_id @@ -44,15 +45,15 @@ def hash_from_email_or_dropbox_id(email_or_id) def hash_from_dropbox_id(dropbox_id) { - :".tag" => :dropbox_id, - :dropbox_id => dropbox_id + ".tag": :dropbox_id, + dropbox_id: dropbox_id } end def hash_from_email(email) { - :".tag" => :email, - :email => email + ".tag": :email, + email: email } end end diff --git a/lib/dropbox_api/metadata/member_action.rb b/lib/dropbox_api/metadata/member_action.rb index 25bc8b94..72ab402c 100644 --- a/lib/dropbox_api/metadata/member_action.rb +++ b/lib/dropbox_api/metadata/member_action.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # An action will be one of the following: # diff --git a/lib/dropbox_api/metadata/member_action_list.rb b/lib/dropbox_api/metadata/member_action_list.rb index d13d5ad4..c009a152 100644 --- a/lib/dropbox_api/metadata/member_action_list.rb +++ b/lib/dropbox_api/metadata/member_action_list.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata class MemberActionList < Array # Builds a list of actions for a shared folder. diff --git a/lib/dropbox_api/metadata/member_permission.rb b/lib/dropbox_api/metadata/member_permission.rb index e10b3295..716ac4a7 100644 --- a/lib/dropbox_api/metadata/member_permission.rb +++ b/lib/dropbox_api/metadata/member_permission.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # This is an example of a serialized {MemberPermission}: # diff --git a/lib/dropbox_api/metadata/member_permission_list.rb b/lib/dropbox_api/metadata/member_permission_list.rb index 59f2e93b..4703d456 100644 --- a/lib/dropbox_api/metadata/member_permission_list.rb +++ b/lib/dropbox_api/metadata/member_permission_list.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # This represents a collection of permissions on allowed on a # shared file or folder. diff --git a/lib/dropbox_api/metadata/metadata_v2.rb b/lib/dropbox_api/metadata/metadata_v2.rb new file mode 100644 index 00000000..21d0b780 --- /dev/null +++ b/lib/dropbox_api/metadata/metadata_v2.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +module DropboxApi::Metadata + class MetadataV2 < Base + field :metadata, DropboxApi::Metadata::Resource + end +end diff --git a/lib/dropbox_api/metadata/name.rb b/lib/dropbox_api/metadata/name.rb index d8eb73d7..6968c58d 100644 --- a/lib/dropbox_api/metadata/name.rb +++ b/lib/dropbox_api/metadata/name.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {Name} object: # diff --git a/lib/dropbox_api/metadata/namespace_id.rb b/lib/dropbox_api/metadata/namespace_id.rb new file mode 100644 index 00000000..9a737975 --- /dev/null +++ b/lib/dropbox_api/metadata/namespace_id.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true +module DropboxApi::Metadata + class NamespaceId < Base + field :namespace_id, String + + def to_hash + super.merge({".tag": 'namespace_id'}) + end + end +end diff --git a/lib/dropbox_api/metadata/parent_folder_access_info.rb b/lib/dropbox_api/metadata/parent_folder_access_info.rb index b70c2ed0..58a8f0d5 100644 --- a/lib/dropbox_api/metadata/parent_folder_access_info.rb +++ b/lib/dropbox_api/metadata/parent_folder_access_info.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata class ParentFolderAccessInfo < Base field :folder_name, String diff --git a/lib/dropbox_api/metadata/photo_metadata.rb b/lib/dropbox_api/metadata/photo_metadata.rb index 1bc0f033..6660fd1f 100644 --- a/lib/dropbox_api/metadata/photo_metadata.rb +++ b/lib/dropbox_api/metadata/photo_metadata.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {PhotoMetadata} object: # diff --git a/lib/dropbox_api/metadata/resource.rb b/lib/dropbox_api/metadata/resource.rb index 1d6adaa7..622d119d 100644 --- a/lib/dropbox_api/metadata/resource.rb +++ b/lib/dropbox_api/metadata/resource.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # This class is used as an adapter so we can create an object of the pertinent # class when we need to infer the type from the data. @@ -9,7 +10,7 @@ module DropboxApi::Metadata class Resource class << self def new(data) - class_for(data[".tag"].to_sym).new(data) + class_for(data['.tag'].to_sym).new(data) end private diff --git a/lib/dropbox_api/metadata/root_info.rb b/lib/dropbox_api/metadata/root_info.rb new file mode 100644 index 00000000..69b2d39f --- /dev/null +++ b/lib/dropbox_api/metadata/root_info.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true +module DropboxApi::Metadata + # Example of a serialized {RootInfo} object: + # + # ```json + # { + # ".tag":"user", + # "root_namespace_id":"42", + # "home_namespace_id":"42" + # } + # ``` + class RootInfo < Base + class << self + def new(data) + class_for(data['.tag'].to_sym).new(data) + end + + private + + def class_for(tag) + case tag + when :user + DropboxApi::Metadata::UserRootInfo + when :team + DropboxApi::Metadata::TeamRootInfo + else + raise ArgumentError, "Unable to infer type for `#{tag}`" + end + end + end + end +end diff --git a/lib/dropbox_api/metadata/search_match_field_options.rb b/lib/dropbox_api/metadata/search_match_field_options.rb new file mode 100644 index 00000000..f04b2582 --- /dev/null +++ b/lib/dropbox_api/metadata/search_match_field_options.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +module DropboxApi::Metadata + class SearchMatchFieldOptions < Base + # Whether to include highlight span from file title. The default for + # this field is False. + field :include_highlights, :boolean, :optional + end +end diff --git a/lib/dropbox_api/metadata/search_match_type_v2.rb b/lib/dropbox_api/metadata/search_match_type_v2.rb new file mode 100644 index 00000000..f797fc3b --- /dev/null +++ b/lib/dropbox_api/metadata/search_match_type_v2.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +module DropboxApi::Metadata + class SearchMatchTypeV2 < DropboxApi::Metadata::Tag + VALID_VALUES = %i[ + filename + file_content + filename_and_content + image_content + ].freeze + + def self.valid_values + VALID_VALUES + end + end +end diff --git a/lib/dropbox_api/metadata/search_match_v2.rb b/lib/dropbox_api/metadata/search_match_v2.rb new file mode 100644 index 00000000..ace95b92 --- /dev/null +++ b/lib/dropbox_api/metadata/search_match_v2.rb @@ -0,0 +1,18 @@ +# frozen_string_literal: true + +module DropboxApi::Metadata + class SearchMatchV2 < Base + # The metadata for the matched file or folder. + field :metadata, DropboxApi::Metadata::MetadataV2 + + # The type of the match. This field is optional. + field :match_type, SearchMatchTypeV2 + + def resource + # for some strange reason, v2 of this search endpoint doesn't have + # the `resource` field anymore and file metadata is wrapped in a + # metadata/metadata field... + metadata.metadata + end + end +end diff --git a/lib/dropbox_api/metadata/search_options.rb b/lib/dropbox_api/metadata/search_options.rb new file mode 100644 index 00000000..746b177a --- /dev/null +++ b/lib/dropbox_api/metadata/search_options.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +module DropboxApi::Metadata + class SearchOptions < Base + # Scopes the search to a path in the user's Dropbox. Searches the entire + # Dropbox if not specified. This field is optional. + field :path, String, :optional + + # The maximum number of search results to return. The default for this + # field is 100. + field :max_results, Integer, :optional + + # Specified property of the order of search results. By default, results + # are sorted by relevance. This field is optional. + field :order_by, DropboxApi::Metadata::SearchOrderBy, :optional + + # Restricts search to the given file status. The default for this union + # is active. + field :file_status, DropboxApi::Metadata::FileStatus, :optional + + # Restricts search to only match on filenames. The default for this field + # is false. + field :filename_only, :boolean, :optional + + # Restricts search to only the extensions specified. Only supported for + # active file search. This field is optional. + field :file_extensions, DropboxApi::Metadata::FileExtensionsList, :optional + + # Restricts search to only the file categories specified. Only supported + # for active file search. This field is optional. + field :file_categories, DropboxApi::Metadata::FileCategoriesList, :optional + end +end diff --git a/lib/dropbox_api/metadata/search_order_by.rb b/lib/dropbox_api/metadata/search_order_by.rb new file mode 100644 index 00000000..4d9e9467 --- /dev/null +++ b/lib/dropbox_api/metadata/search_order_by.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module DropboxApi::Metadata + class SearchOrderBy < DropboxApi::Metadata::Tag + VALID_VALUES = %i[ + relevance + last_modified_time + ].freeze + + def self.valid_values + VALID_VALUES + end + end +end diff --git a/lib/dropbox_api/metadata/shared_folder.rb b/lib/dropbox_api/metadata/shared_folder.rb index 4544684f..1f7f1560 100644 --- a/lib/dropbox_api/metadata/shared_folder.rb +++ b/lib/dropbox_api/metadata/shared_folder.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {SharedFolder} object: # diff --git a/lib/dropbox_api/metadata/shared_folder_policy.rb b/lib/dropbox_api/metadata/shared_folder_policy.rb index d8591051..07518179 100644 --- a/lib/dropbox_api/metadata/shared_folder_policy.rb +++ b/lib/dropbox_api/metadata/shared_folder_policy.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {SharedFolderPolicy} object: # diff --git a/lib/dropbox_api/metadata/shared_link.rb b/lib/dropbox_api/metadata/shared_link.rb index 4b421171..36ac5413 100644 --- a/lib/dropbox_api/metadata/shared_link.rb +++ b/lib/dropbox_api/metadata/shared_link.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata class SharedLink < Base VALID_KEYS = [:url, :password] @@ -6,7 +7,7 @@ def initialize(param) @shared_link = case param when String - {:url => param} + {url: param} when Hash param end @@ -16,7 +17,7 @@ def initialize(param) def check_validity if @shared_link[:url].nil? - raise ArgumentError, "Missing `:url` option" + raise ArgumentError, 'Missing `:url` option' end @shared_link.keys.each do |key| diff --git a/lib/dropbox_api/metadata/shared_link_metadata.rb b/lib/dropbox_api/metadata/shared_link_metadata.rb index 6da8ed31..1299cfd2 100644 --- a/lib/dropbox_api/metadata/shared_link_metadata.rb +++ b/lib/dropbox_api/metadata/shared_link_metadata.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # This class is used as an adapter so we can create an object of the pertinent # class when we need to infer the type from the data. @@ -6,7 +7,7 @@ module DropboxApi::Metadata class SharedLinkMetadata class << self def new(data) - class_for(data[".tag"].to_sym).new(data) + class_for(data['.tag'].to_sym).new(data) end private diff --git a/lib/dropbox_api/metadata/space_allocation.rb b/lib/dropbox_api/metadata/space_allocation.rb index d07e5cfa..6efe1785 100644 --- a/lib/dropbox_api/metadata/space_allocation.rb +++ b/lib/dropbox_api/metadata/space_allocation.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {SpaceAllocation} object: # diff --git a/lib/dropbox_api/metadata/space_usage.rb b/lib/dropbox_api/metadata/space_usage.rb index 36348e72..f357f70e 100644 --- a/lib/dropbox_api/metadata/space_usage.rb +++ b/lib/dropbox_api/metadata/space_usage.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {SpaceUsage} object: # diff --git a/lib/dropbox_api/metadata/tag.rb b/lib/dropbox_api/metadata/tag.rb index d38834d9..468af663 100644 --- a/lib/dropbox_api/metadata/tag.rb +++ b/lib/dropbox_api/metadata/tag.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata class Tag < DropboxApi::Metadata::Base def self.new(data) @@ -5,7 +6,7 @@ def self.new(data) when ::Symbol validate(data) when Hash - new(data[".tag"].to_sym) + new(data['.tag'].to_sym) when String new(data.to_sym) else diff --git a/lib/dropbox_api/metadata/team.rb b/lib/dropbox_api/metadata/team.rb index 9ccc2f38..9d4b6e6b 100644 --- a/lib/dropbox_api/metadata/team.rb +++ b/lib/dropbox_api/metadata/team.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata class Team < Base field :id, String diff --git a/lib/dropbox_api/metadata/team_member_info.rb b/lib/dropbox_api/metadata/team_member_info.rb index b3c7ecc3..e0692367 100644 --- a/lib/dropbox_api/metadata/team_member_info.rb +++ b/lib/dropbox_api/metadata/team_member_info.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {TeamMemberInfo} object: # diff --git a/lib/dropbox_api/metadata/team_root_info.rb b/lib/dropbox_api/metadata/team_root_info.rb new file mode 100644 index 00000000..d83d7757 --- /dev/null +++ b/lib/dropbox_api/metadata/team_root_info.rb @@ -0,0 +1,8 @@ +# frozen_string_literal: true +module DropboxApi::Metadata + class TeamRootInfo < Base + field :root_namespace_id, String + field :home_namespace_id, String + field :home_path, String + end +end diff --git a/lib/dropbox_api/metadata/thumbnail_batch_result_data.rb b/lib/dropbox_api/metadata/thumbnail_batch_result_data.rb index 509d97c0..59242aa3 100644 --- a/lib/dropbox_api/metadata/thumbnail_batch_result_data.rb +++ b/lib/dropbox_api/metadata/thumbnail_batch_result_data.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata class ThumbnailBatchResultData < Base field :metadata, DropboxApi::Metadata::File diff --git a/lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb b/lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb index 0215b95a..810a006e 100644 --- a/lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb +++ b/lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # This class is used as an adapter so we can create an object of the pertinent # class when we need to infer the type from the data. @@ -9,11 +10,11 @@ module DropboxApi::Metadata class ThumbnailBatchResultEntry class << self def new(data) - case data[".tag"].to_sym + case data['.tag'].to_sym when :success DropboxApi::Metadata::ThumbnailBatchResultData.new(data) when :failure - DropboxApi::Errors::ThumbnailError.build("Thumbnail generation failed", data["failure"]) + DropboxApi::Errors::ThumbnailError.build('Thumbnail generation failed', data['failure']) else raise NotImplementedError, "Unknown result type: #{data[".tag"]}" end diff --git a/lib/dropbox_api/metadata/upload_session_cursor.rb b/lib/dropbox_api/metadata/upload_session_cursor.rb index 5fe71324..1aeff6b6 100644 --- a/lib/dropbox_api/metadata/upload_session_cursor.rb +++ b/lib/dropbox_api/metadata/upload_session_cursor.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {UploadSessionCursor} object: # diff --git a/lib/dropbox_api/metadata/user_root_info.rb b/lib/dropbox_api/metadata/user_root_info.rb new file mode 100644 index 00000000..3b3e2e58 --- /dev/null +++ b/lib/dropbox_api/metadata/user_root_info.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true +module DropboxApi::Metadata + class UserRootInfo < Base + field :root_namespace_id, String + field :home_namespace_id, String + end +end diff --git a/lib/dropbox_api/metadata/video_metadata.rb b/lib/dropbox_api/metadata/video_metadata.rb index 5c1d12e3..2784c10d 100644 --- a/lib/dropbox_api/metadata/video_metadata.rb +++ b/lib/dropbox_api/metadata/video_metadata.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Example of a serialized {MediaInfo} object: # diff --git a/lib/dropbox_api/metadata/write_mode.rb b/lib/dropbox_api/metadata/write_mode.rb index 05c2e2c5..d9ceecac 100644 --- a/lib/dropbox_api/metadata/write_mode.rb +++ b/lib/dropbox_api/metadata/write_mode.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Metadata # Your intent when writing a file to some path. This is used to determine # what constitutes a conflict and what the autorename strategy is. @@ -48,22 +49,22 @@ def initialize(write_mode, options = nil) @write_mode = write_mode when String, ::Symbol @write_mode = { - ".tag" => write_mode + '.tag' => write_mode } @write_mode[write_mode.to_s] = options unless options.nil? end - @write_mode[".tag"] = @write_mode[".tag"].to_sym + @write_mode['.tag'] = @write_mode['.tag'].to_sym check_validity end def check_validity - unless valid_mode? @write_mode[".tag"] + unless valid_mode? @write_mode['.tag'] raise ArgumentError, "Invalid write mode: #{@write_mode[".tag"]}" end - if @write_mode[".tag"] == :update && @write_mode["update"].nil? - raise ArgumentError, "Mode `:update` expects a `rev` number" + if @write_mode['.tag'] == :update && @write_mode['update'].nil? + raise ArgumentError, 'Mode `:update` expects a `rev` number' end end diff --git a/lib/dropbox_api/middleware/decode_result.rb b/lib/dropbox_api/middleware/decode_result.rb index 85df5152..3b60af09 100644 --- a/lib/dropbox_api/middleware/decode_result.rb +++ b/lib/dropbox_api/middleware/decode_result.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::MiddleWare class DecodeResult < Faraday::Middleware def call(rq_env) @@ -14,7 +15,7 @@ def decode(json) # Dropbox may send a response with the string 'null' in its body, this # would be a void result. `add_folder_member` is an example of an # endpoint without return values. - if json == "null" + if json == 'null' {} else JSON.parse json @@ -22,5 +23,5 @@ def decode(json) end end - Faraday::Response.register_middleware :decode_result => DecodeResult + Faraday::Response.register_middleware decode_result: DecodeResult end diff --git a/lib/dropbox_api/middleware/path_root.rb b/lib/dropbox_api/middleware/path_root.rb new file mode 100644 index 00000000..8ca658e2 --- /dev/null +++ b/lib/dropbox_api/middleware/path_root.rb @@ -0,0 +1,35 @@ +# frozen_string_literal: true +module DropboxApi::MiddleWare + class PathRoot < Faraday::Middleware + HEADER_NAME = 'Dropbox-API-Path-Root' + + def initialize(app, options = {}) + super(app) + @options = options + end + + def namespace_id + if @options[:namespace_id].nil? + return nil + else + return @options[:namespace_id] + end + end + + def namespace_id_header_value + JSON.dump( + DropboxApi::Metadata::NamespaceId.new({ + 'namespace_id' => namespace_id + }).to_hash + ) + end + + def call(env) + if !namespace_id.nil? + env[:request_headers][HEADER_NAME] ||= namespace_id_header_value + end + + @app.call env + end + end +end diff --git a/lib/dropbox_api/middleware/stack.rb b/lib/dropbox_api/middleware/stack.rb index 47399f3a..ec990e99 100644 --- a/lib/dropbox_api/middleware/stack.rb +++ b/lib/dropbox_api/middleware/stack.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::MiddleWare class Stack def initialize diff --git a/lib/dropbox_api/options_validator.rb b/lib/dropbox_api/options_validator.rb index 1c401ba7..9ede210b 100644 --- a/lib/dropbox_api/options_validator.rb +++ b/lib/dropbox_api/options_validator.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi module OptionsValidator # Takes in a list of valid option keys and a hash of options. If one of the diff --git a/lib/dropbox_api/result_builder.rb b/lib/dropbox_api/result_builder.rb index c08b01bc..b127717b 100644 --- a/lib/dropbox_api/result_builder.rb +++ b/lib/dropbox_api/result_builder.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi class ResultBuilder def initialize(response_data) @@ -5,11 +6,11 @@ def initialize(response_data) end def error_summary - @response_data["error_summary"] if @response_data.is_a? Hash + @response_data['error_summary'] if @response_data.is_a? Hash end def error - @response_data["error"] + @response_data['error'] end def has_error? diff --git a/lib/dropbox_api/results/add_file_member_result_list.rb b/lib/dropbox_api/results/add_file_member_result_list.rb index c40c517d..8d06775c 100644 --- a/lib/dropbox_api/results/add_file_member_result_list.rb +++ b/lib/dropbox_api/results/add_file_member_result_list.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Results # Example of a result of the `add_file_member` endpoint: # [{ diff --git a/lib/dropbox_api/results/base.rb b/lib/dropbox_api/results/base.rb index e7060458..577b67c6 100644 --- a/lib/dropbox_api/results/base.rb +++ b/lib/dropbox_api/results/base.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Results class Base def initialize(result_data) diff --git a/lib/dropbox_api/results/basic_account_batch.rb b/lib/dropbox_api/results/basic_account_batch.rb index 34ae4937..e213a9a4 100644 --- a/lib/dropbox_api/results/basic_account_batch.rb +++ b/lib/dropbox_api/results/basic_account_batch.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Results class BasicAccountBatch < Array def initialize(accounts) diff --git a/lib/dropbox_api/results/copy_batch_result.rb b/lib/dropbox_api/results/copy_batch_result.rb index c59ea87b..ef08c862 100644 --- a/lib/dropbox_api/results/copy_batch_result.rb +++ b/lib/dropbox_api/results/copy_batch_result.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Results class CopyBatchResult < DropboxApi::Results::Base def self.new(result_data) - case result_data[".tag"] + case result_data['.tag'] when 'async_job_id' result_data['async_job_id'] when 'complete' diff --git a/lib/dropbox_api/results/create_folder_batch_result.rb b/lib/dropbox_api/results/create_folder_batch_result.rb index 71ced0a5..0d98437e 100644 --- a/lib/dropbox_api/results/create_folder_batch_result.rb +++ b/lib/dropbox_api/results/create_folder_batch_result.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Results # Result returned by {Client#create_folder_batch} that may either launch an # asynchronous job or complete synchronously. @@ -5,11 +6,11 @@ module DropboxApi::Results # The value will be either a job id or a list of job statuses. class CreateFolderBatchResult < DropboxApi::Results::Base def self.new(result_data) - case result_data[".tag"] - when "async_job_id" + case result_data['.tag'] + when 'async_job_id' result_data - when "complete" - result_data["entries"].map do |entry| + when 'complete' + result_data['entries'].map do |entry| DropboxApi::Results::CreateFolderBatchResultEntry.new(entry) end else diff --git a/lib/dropbox_api/results/create_folder_batch_result_entry.rb b/lib/dropbox_api/results/create_folder_batch_result_entry.rb index 09889930..fc07f915 100644 --- a/lib/dropbox_api/results/create_folder_batch_result_entry.rb +++ b/lib/dropbox_api/results/create_folder_batch_result_entry.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Results class CreateFolderBatchResultEntry < DropboxApi::Results::Base def self.new(result_data) diff --git a/lib/dropbox_api/results/delete_batch_result.rb b/lib/dropbox_api/results/delete_batch_result.rb index 5d52f8ca..672078cf 100644 --- a/lib/dropbox_api/results/delete_batch_result.rb +++ b/lib/dropbox_api/results/delete_batch_result.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Results # Result returned by {Client#delete_batch} that may either launch an # asynchronous job or complete synchronously. @@ -5,11 +6,11 @@ module DropboxApi::Results # The value will be either a job id or a list of job statuses. class DeleteBatchResult < DropboxApi::Results::Base def self.new(result_data) - case result_data[".tag"] - when "async_job_id" + case result_data['.tag'] + when 'async_job_id' result_data - when "complete" - result_data["entries"].map do |entry| + when 'complete' + result_data['entries'].map do |entry| DropboxApi::Results::DeleteBatchResultEntry.new(entry) end else diff --git a/lib/dropbox_api/results/delete_batch_result_entry.rb b/lib/dropbox_api/results/delete_batch_result_entry.rb index daa229d2..3b89f41e 100644 --- a/lib/dropbox_api/results/delete_batch_result_entry.rb +++ b/lib/dropbox_api/results/delete_batch_result_entry.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Results class DeleteBatchResultEntry < DropboxApi::Results::Base def self.new(result_data) diff --git a/lib/dropbox_api/results/get_copy_reference_result.rb b/lib/dropbox_api/results/get_copy_reference_result.rb index c3102732..ce3d3a9d 100644 --- a/lib/dropbox_api/results/get_copy_reference_result.rb +++ b/lib/dropbox_api/results/get_copy_reference_result.rb @@ -1,20 +1,21 @@ +# frozen_string_literal: true module DropboxApi::Results class GetCopyReferenceResult < DropboxApi::Results::Base # Metadata of the file or folder. def resource - @resource ||= DropboxApi::Metadata::Resource.new @data["metadata"] + @resource ||= DropboxApi::Metadata::Resource.new @data['metadata'] end # A copy reference to the file or folder. def copy_reference - @copy_reference ||= @data["copy_reference"] + @copy_reference ||= @data['copy_reference'] end # The expiration date of the copy reference. # This value is currently set to be far enough in the future # so that expiration is effectively not an issue. def expires - @expires ||= Time.parse(@data["expires"]) + @expires ||= Time.parse(@data['expires']) end end end diff --git a/lib/dropbox_api/results/get_temporary_link_result.rb b/lib/dropbox_api/results/get_temporary_link_result.rb index 32d2ee64..0025eccc 100644 --- a/lib/dropbox_api/results/get_temporary_link_result.rb +++ b/lib/dropbox_api/results/get_temporary_link_result.rb @@ -1,11 +1,12 @@ +# frozen_string_literal: true module DropboxApi::Results class GetTemporaryLinkResult < DropboxApi::Results::Base def file - @file ||= DropboxApi::Metadata::File.new(@data["metadata"]) + @file ||= DropboxApi::Metadata::File.new(@data['metadata']) end def link - @data["link"] + @data['link'] end end end diff --git a/lib/dropbox_api/results/get_thumbnail_batch_result.rb b/lib/dropbox_api/results/get_thumbnail_batch_result.rb index 94c6d940..3aa3a502 100644 --- a/lib/dropbox_api/results/get_thumbnail_batch_result.rb +++ b/lib/dropbox_api/results/get_thumbnail_batch_result.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Results class GetThumbnailBatchResult < DropboxApi::Results::Base def entries - @entries ||= @data["entries"].map do |entry| + @entries ||= @data['entries'].map do |entry| DropboxApi::Metadata::ThumbnailBatchResultEntry.new entry end end diff --git a/lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb b/lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb index 230b62da..1ba50be8 100644 --- a/lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb +++ b/lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Results class ListFolderGetLatestCursorResult < DropboxApi::Results::Base def cursor - @data["cursor"] + @data['cursor'] end end end diff --git a/lib/dropbox_api/results/list_folder_longpoll_result.rb b/lib/dropbox_api/results/list_folder_longpoll_result.rb index 5e8a7acf..c095c4a3 100644 --- a/lib/dropbox_api/results/list_folder_longpoll_result.rb +++ b/lib/dropbox_api/results/list_folder_longpoll_result.rb @@ -1,15 +1,16 @@ +# frozen_string_literal: true module DropboxApi::Results class ListFolderLongpollResult < DropboxApi::Results::Base # Indicates whether new changes are available. If true, call # `list_folder_continue` to retrieve the changes. def changes - @data["changes"].to_s == "true" + @data['changes'].to_s == 'true' end # If present, backoff for at least this many seconds before calling # `list_folder_longpoll` again. This field is optional. def backoff - @data["backoff"] + @data['backoff'] end end end diff --git a/lib/dropbox_api/results/list_folder_result.rb b/lib/dropbox_api/results/list_folder_result.rb index afdad317..014e0669 100644 --- a/lib/dropbox_api/results/list_folder_result.rb +++ b/lib/dropbox_api/results/list_folder_result.rb @@ -1,8 +1,9 @@ +# frozen_string_literal: true module DropboxApi::Results class ListFolderResult < DropboxApi::Results::Base # A collection of files and directories. def entries - @entries ||= @data["entries"].map do |entry| + @entries ||= @data['entries'].map do |entry| DropboxApi::Metadata::Resource.new entry end end @@ -10,13 +11,13 @@ def entries # Pass the cursor into `list_folder_continue` to see what's changed in the # folder since your previous query. def cursor - @data["cursor"] + @data['cursor'] end # If true, then there are more entries available. Pass the cursor to # `list_folder_continue` to retrieve the rest. def has_more? - @data["has_more"].to_s == "true" + @data['has_more'].to_s == 'true' end end end diff --git a/lib/dropbox_api/results/list_revisions_result.rb b/lib/dropbox_api/results/list_revisions_result.rb index ef4530a4..8891f694 100644 --- a/lib/dropbox_api/results/list_revisions_result.rb +++ b/lib/dropbox_api/results/list_revisions_result.rb @@ -1,14 +1,15 @@ +# frozen_string_literal: true module DropboxApi::Results class ListRevisionsResult < DropboxApi::Results::Base # A collection of files and directories. def entries - @entries ||= @data["entries"].map do |entry| + @entries ||= @data['entries'].map do |entry| DropboxApi::Metadata::File.new entry end end def is_deleted? - @data["is_deleted"] == true + @data['is_deleted'] == true end end end diff --git a/lib/dropbox_api/results/list_shared_links_result.rb b/lib/dropbox_api/results/list_shared_links_result.rb index b58faaa0..a5cb12e4 100644 --- a/lib/dropbox_api/results/list_shared_links_result.rb +++ b/lib/dropbox_api/results/list_shared_links_result.rb @@ -1,8 +1,9 @@ +# frozen_string_literal: true module DropboxApi::Results class ListSharedLinksResult < DropboxApi::Results::Base # Shared links applicable to the path argument. def links - @entries ||= @data["links"].map do |entry| + @entries ||= @data['links'].map do |entry| DropboxApi::Metadata::SharedLinkMetadata.new entry end end @@ -10,13 +11,13 @@ def links # Pass the cursor into `list_folder_continue` to see what's changed in the # folder since your previous query. def cursor - @data["cursor"] + @data['cursor'] end # If true, then there are more entries available. Pass the cursor to # `list_folder_continue` to retrieve the rest. def has_more? - @data["has_more"].to_s == "true" + @data['has_more'].to_s == 'true' end end end diff --git a/lib/dropbox_api/results/relocation_batch_result.rb b/lib/dropbox_api/results/relocation_batch_result.rb index 6b98de61..433a3ba0 100644 --- a/lib/dropbox_api/results/relocation_batch_result.rb +++ b/lib/dropbox_api/results/relocation_batch_result.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Results # Result returned by {Client#copy_batch} or {Client#move_batch} that may # either launch an asynchronous job or complete synchronously. @@ -5,11 +6,11 @@ module DropboxApi::Results # The value will be either `:in_progress` or a list of job statuses. class RelocationBatchResult < DropboxApi::Results::Base def self.new(result_data) - case result_data[".tag"] - when "in_progress" + case result_data['.tag'] + when 'in_progress' :in_progress - when "complete" - result_data["entries"].map do |entry| + when 'complete' + result_data['entries'].map do |entry| DropboxApi::Results::RelocationBatchResultEntry.new(entry) end else diff --git a/lib/dropbox_api/results/relocation_batch_result_entry.rb b/lib/dropbox_api/results/relocation_batch_result_entry.rb index d8b67cae..db97cb32 100644 --- a/lib/dropbox_api/results/relocation_batch_result_entry.rb +++ b/lib/dropbox_api/results/relocation_batch_result_entry.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Results class RelocationBatchResultEntry < DropboxApi::Results::Base def self.new(result_data) diff --git a/lib/dropbox_api/results/save_copy_reference_result.rb b/lib/dropbox_api/results/save_copy_reference_result.rb index f3a69d09..c76d26a3 100644 --- a/lib/dropbox_api/results/save_copy_reference_result.rb +++ b/lib/dropbox_api/results/save_copy_reference_result.rb @@ -1,8 +1,9 @@ +# frozen_string_literal: true module DropboxApi::Results class SaveCopyReferenceResult < DropboxApi::Results::Base # The saved file or folder in the user's Dropbox. def resource - @resource ||= DropboxApi::Metadata::Resource.new @data["metadata"] + @resource ||= DropboxApi::Metadata::Resource.new @data['metadata'] end end end diff --git a/lib/dropbox_api/results/save_url_job_status.rb b/lib/dropbox_api/results/save_url_job_status.rb index 369dc0a8..06716332 100644 --- a/lib/dropbox_api/results/save_url_job_status.rb +++ b/lib/dropbox_api/results/save_url_job_status.rb @@ -1,14 +1,15 @@ +# frozen_string_literal: true module DropboxApi::Results class SaveUrlJobStatus < DropboxApi::Results::Base def self.new(result_data) - case result_data[".tag"] - when "in_progress" + case result_data['.tag'] + when 'in_progress' :in_progress - when "complete" + when 'complete' DropboxApi::Metadata::File.new result_data - when "failed" - DropboxApi::Errors::SaveUrlError.build("Async job failed", - result_data["failed"]) + when 'failed' + DropboxApi::Errors::SaveUrlError.build('Async job failed', + result_data['failed']) else raise NotImplementedError, "Unknown result type: #{result_data[".tag"]}" end diff --git a/lib/dropbox_api/results/save_url_result.rb b/lib/dropbox_api/results/save_url_result.rb index 91f96b86..0eb9ca1c 100644 --- a/lib/dropbox_api/results/save_url_result.rb +++ b/lib/dropbox_api/results/save_url_result.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Results class SaveUrlResult < DropboxApi::Results::Base # Example with an async job: @@ -8,7 +9,7 @@ class SaveUrlResult < DropboxApi::Results::Base # # I couldn't manage to get anything other than an async job. def async_job_id - @data["async_job_id"] + @data['async_job_id'] end end end diff --git a/lib/dropbox_api/results/search/match.rb b/lib/dropbox_api/results/search/match.rb index 78a42769..b00f8b25 100644 --- a/lib/dropbox_api/results/search/match.rb +++ b/lib/dropbox_api/results/search/match.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Results::Search class Match def initialize(data) @@ -5,11 +6,11 @@ def initialize(data) end def match_type - @data["match_type"] + @data['match_type'] end def resource - @resource ||= DropboxApi::Metadata::Resource.new @data["metadata"] + @resource ||= DropboxApi::Metadata::Resource.new @data['metadata'] end end end diff --git a/lib/dropbox_api/results/search_result.rb b/lib/dropbox_api/results/search_result.rb deleted file mode 100644 index 63e80d4e..00000000 --- a/lib/dropbox_api/results/search_result.rb +++ /dev/null @@ -1,22 +0,0 @@ -module DropboxApi::Results - class SearchResult < DropboxApi::Results::Base - # A list (possibly empty) of matches for the query. - def matches - @matches ||= @data["matches"].map do |match| - DropboxApi::Results::Search::Match.new match - end - end - - # Used for paging. Value to set the start argument to when calling search - # to fetch the next page of results. - def start - @data["start"].to_i - end - - # Used for paging. If true, indicates there is another page of results - # available that can be fetched by calling search again. - def has_more? - @data["more"].to_s == "true" - end - end -end diff --git a/lib/dropbox_api/results/search_v2_result.rb b/lib/dropbox_api/results/search_v2_result.rb new file mode 100644 index 00000000..e1eecbf8 --- /dev/null +++ b/lib/dropbox_api/results/search_v2_result.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true +module DropboxApi::Results + class SearchV2Result < DropboxApi::Results::Base + # A list (possibly empty) of matches for the query. + def matches + @matches ||= @data['matches'].map do |match| + DropboxApi::Metadata::SearchMatchV2.new match + end + end + + # Used for paging. If true, indicates there is another page of results + # available that can be fetched by calling search again. + def has_more? + @data['has_more'].to_s == 'true' + end + + # Pass the cursor into #search_continue to fetch the next page of results. + # This field is optional. + def cursor + @data['cursor'] + end + end +end diff --git a/lib/dropbox_api/results/share_folder_launch.rb b/lib/dropbox_api/results/share_folder_launch.rb index 32ef02d0..08fd47bf 100644 --- a/lib/dropbox_api/results/share_folder_launch.rb +++ b/lib/dropbox_api/results/share_folder_launch.rb @@ -1,10 +1,11 @@ +# frozen_string_literal: true module DropboxApi::Results class ShareFolderLaunch def self.new(result_data) - case result_data[".tag"] - when "complete" + case result_data['.tag'] + when 'complete' DropboxApi::Metadata::SharedFolder.new result_data - when "async_job_id" + when 'async_job_id' result_data else raise ArgumentError, "Unable to infer resource type for `#{tag}`" diff --git a/lib/dropbox_api/results/shared_file_members.rb b/lib/dropbox_api/results/shared_file_members.rb index 1b231ff2..774faa0d 100644 --- a/lib/dropbox_api/results/shared_file_members.rb +++ b/lib/dropbox_api/results/shared_file_members.rb @@ -1,19 +1,20 @@ +# frozen_string_literal: true module DropboxApi::Results class SharedFileMembers < DropboxApi::Results::Base def users - @data["users"] + @data['users'] end def groups - @data["groups"] + @data['groups'] end def invitees - @data["invitees"] + @data['invitees'] end def cursor - @data["cursor"] + @data['cursor'] end end end diff --git a/lib/dropbox_api/results/shared_folder_members.rb b/lib/dropbox_api/results/shared_folder_members.rb index 864927d9..c72e8f30 100644 --- a/lib/dropbox_api/results/shared_folder_members.rb +++ b/lib/dropbox_api/results/shared_folder_members.rb @@ -1,19 +1,20 @@ +# frozen_string_literal: true module DropboxApi::Results class SharedFolderMembers < DropboxApi::Results::Base def users - @data["users"] + @data['users'] end def groups - @data["groups"] + @data['groups'] end def invitees - @data["invitees"] + @data['invitees'] end def cursor - @data["cursor"] + @data['cursor'] end end end diff --git a/lib/dropbox_api/results/upload_session_start.rb b/lib/dropbox_api/results/upload_session_start.rb index 6d4d875b..f5ea6646 100644 --- a/lib/dropbox_api/results/upload_session_start.rb +++ b/lib/dropbox_api/results/upload_session_start.rb @@ -1,7 +1,8 @@ +# frozen_string_literal: true module DropboxApi::Results class UploadSessionStart < DropboxApi::Results::Base def session_id - @data["session_id"] + @data['session_id'] end end end diff --git a/lib/dropbox_api/results/void_result.rb b/lib/dropbox_api/results/void_result.rb index f11ea327..a53fda30 100644 --- a/lib/dropbox_api/results/void_result.rb +++ b/lib/dropbox_api/results/void_result.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi::Results class VoidResult < DropboxApi::Results::Base end diff --git a/lib/dropbox_api/version.rb b/lib/dropbox_api/version.rb index b6ab9f30..6d6ee04b 100644 --- a/lib/dropbox_api/version.rb +++ b/lib/dropbox_api/version.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi - VERSION = '0.1.18'.freeze + VERSION = '0.1.21' end diff --git a/spec/authenticator_spec.rb b/spec/authenticator_spec.rb new file mode 100644 index 00000000..54437659 --- /dev/null +++ b/spec/authenticator_spec.rb @@ -0,0 +1,40 @@ +# frozen_string_literal: true +module DropboxApi + describe Authenticator do + before :each do + # These details belong to an account I manually created for testing + client_id = "CLIENT_ID" + client_secret = "CLIENT_SECRET" + + @authenticator = DropboxApi::Authenticator.new(client_id, client_secret) + end + + it 'successfully generates a short lived token', cassette: 'authenticator/success_with_short_lived_token' do + # At this point we could get an authorization URL with: + # `@authenticator.auth_code.authorize_url` # => 'https://www.dropbox...' + + # The URL above gave us the following access code: + access_code = "ACCESS_CODEhVAVTMlCvO0Qs" + + access_token = @authenticator.auth_code.get_token(access_code) + + expect(access_token).to be_a(OAuth2::AccessToken) + expect(access_token.token).to eq("MOCK_ACCESS_TOKEN") + expect(access_token.refresh_token).to be_nil + end + + it 'successfully generates a refresh token', cassette: 'authenticator/success_with_refresh_token' do + # We now get an authorization URL with: + # `@authenticator.auth_code.authorize_url(token_access_type: 'offline')` + + # We got the following access code: + access_code = "ACCESS_CODEpLfs_y4vgnb3M" + + access_token = @authenticator.auth_code.get_token(access_code) + + expect(access_token).to be_a(OAuth2::AccessToken) + expect(access_token.token).to eq("MOCK_ACCESS_TOKEN") + expect(access_token.refresh_token).to eq("MOCK_REFRESH_TOKEN") + end + end +end diff --git a/spec/chunked_uploader_spec.rb b/spec/chunked_uploader_spec.rb index c18e00bf..1dd03a20 100644 --- a/spec/chunked_uploader_spec.rb +++ b/spec/chunked_uploader_spec.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module DropboxApi describe ChunkedUploader do let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :chunked_uploader } @@ -6,11 +7,11 @@ module DropboxApi @client = DropboxApi::Client.new end - it 'uploads a empty string', :cassette => "chunked_uploader/success_with_empty_string" do - content = StringIO.new("") + it 'uploads a empty string', cassette: 'chunked_uploader/success_with_empty_string' do + content = StringIO.new('') uploader = DropboxApi::ChunkedUploader.new(@client, "#{path_prefix}/new_file.txt", content, { - :chunk_size => 4 + chunk_size: 4 }) uploader.start uploader.upload @@ -20,11 +21,11 @@ module DropboxApi expect(file_data.name).to eq('new_file.txt') end - it 'uploads a file', :cassette => "chunked_uploader/success" do - content = File.open(File.join(DropboxScaffoldBuilder.fixtures_path, "file.txt")) + it 'uploads a file', cassette: 'chunked_uploader/success' do + content = File.open(File.join(DropboxScaffoldBuilder.fixtures_path, 'file.txt')) uploader = DropboxApi::ChunkedUploader.new(@client, "#{path_prefix}/new_file.txt", content, { - :chunk_size => 4 + chunk_size: 4 }) uploader.start uploader.upload diff --git a/spec/client_spec.rb b/spec/client_spec.rb index 5c4bd0d2..289a72bb 100644 --- a/spec/client_spec.rb +++ b/spec/client_spec.rb @@ -1,3 +1,9 @@ +# frozen_string_literal: true +if Gem::Requirement.new('>= 2.0').satisfied_by? Gem.loaded_specs['faraday'].version + require 'faraday/net_http_persistent' +end + + module DropboxApi describe Client do it 'can have custom connection middleware' do @@ -22,21 +28,86 @@ module DropboxApi faraday.use MiddlewareMiddle end - # Workaround the API changes Faraday introduced in 1.0 :( - if Faraday::VERSION.start_with? "0." - expect(connection.builder.handlers).to eq [ - MiddlewareStart, - MiddlewareMiddle, - MiddlewareEnd, - Faraday::Adapter::NetHttpPersistent - ] - else - expected = Faraday::RackBuilder.new( - [MiddlewareStart, MiddlewareMiddle, MiddlewareEnd], - Faraday::Adapter::NetHttpPersistent + expect(connection.builder.adapter).to eq(Faraday::Adapter::NetHttpPersistent) + expect(connection.builder.handlers).to eq([ + DropboxApi::MiddleWare::PathRoot, + MiddlewareStart, + Faraday::Request::Authorization, + MiddlewareMiddle, + MiddlewareEnd + ]) + end + + describe "Refreshing access tokens" do + before :each do + client_id = "CLIENT_ID" + client_secret = "CLIENT_SECRET" + @authenticator = DropboxApi::Authenticator.new(client_id, client_secret) + end + + it 'will raise on 401 if there is no refresh token', cassette: 'client/raise_on_401' do + client = Client.new("MOCK_EXPIRED_AUTHORIZATION_BEARER") + + expect do + client.list_folder "" + end.to raise_error(DropboxApi::Errors::ExpiredAccessTokenError) + end + + it 'will refresh the access token if expired', cassette: 'client/refresh_token_if_expired' do + token_hash = { + "uid" => "44076342", + "token_type" => "bearer", + "scope" => "account_info.read account_info.write contacts.read contacts.write file_requests.read file_requests.write files.content.read files.content.write files.metadata.read files.metadata.write sharing.read sharing.write", + "account_id" => "dbid:AABOLtA1rT6rRK4vakdslWqLZ7wVnV863u4", + :access_token => "MOCK_ACCESS_TOKEN", + :refresh_token => "MOCK_REFRESH_TOKEN", + :expires_at => 1232946918 + } + + access_token = OAuth2::AccessToken.from_hash(@authenticator, token_hash) + + new_token_hash = nil + client = Client.new( + access_token: access_token, + on_token_refreshed: lambda { |token_hash| + new_token_hash = token_hash + } ) + result = client.list_folder "" + + expect(result).to be_a(DropboxApi::Results::ListFolderResult) + expect(new_token_hash[:access_token]).to eq("MOCK_ACCESS_TOKEN") + end + + it 'will refresh the access token on 401', cassette: 'client/refresh_token_on_401' do + token_hash = { + "uid" => "44076342", + "token_type" => "bearer", + "scope" => "account_info.read account_info.write contacts.read contacts.write file_requests.read file_requests.write files.content.read files.content.write files.metadata.read files.metadata.write sharing.read sharing.write", + "account_id" => "dbid:AABOLtA1rT6rRK4vajKZrWqLZ7wVnV863u4", + :access_token => "MOCK_ACCESS_TOKEN", + :refresh_token => "MOCK_REFRESH_TOKEN", + :expires_at => 1732948328 + } + + access_token = OAuth2::AccessToken.from_hash(@authenticator, token_hash) + + new_token_hash = nil + client = Client.new( + access_token: access_token, + on_token_refreshed: lambda { |token_hash| + new_token_hash = token_hash + } + ) + + # The following uses a VCR recording with a 401, then the client + # refreshes the token and retries. So it seamlessly works making + # the refresh unnoticeable. + result = client.list_folder "" - expect(connection.builder).to eq(expected) + expect(result).to be_a(DropboxApi::Results::ListFolderResult) + # Verify that the callback gets called on token refresh... + expect(new_token_hash[:access_token]).to eq("MOCK_REFRESHED_ACCESS_TOKEN") end end end diff --git a/spec/dropbox_api_v2_spec.rb b/spec/dropbox_api_v2_spec.rb index 81e1f5b0..a0ba1717 100644 --- a/spec/dropbox_api_v2_spec.rb +++ b/spec/dropbox_api_v2_spec.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true describe DropboxApi do it 'has a version number' do expect(DropboxApi::VERSION).not_to be nil diff --git a/spec/endpoints/auth/token_revoke_spec.rb b/spec/endpoints/auth/token_revoke_spec.rb index e3a2d850..0fcf485a 100644 --- a/spec/endpoints/auth/token_revoke_spec.rb +++ b/spec/endpoints/auth/token_revoke_spec.rb @@ -1,9 +1,10 @@ -describe DropboxApi::Client, "#token_revoke" do +# frozen_string_literal: true +describe DropboxApi::Client, '#token_revoke' do before :each do @client = DropboxApi::Client.new end - it "revokes the token", :cassette => "token_revoke/success" do + it 'revokes the token', cassette: 'token_revoke/success' do account = @client.token_revoke #endpoint has no response to test diff --git a/spec/endpoints/content_upload_spec.rb b/spec/endpoints/content_upload_spec.rb index 91270d58..7dcf0bab 100644 --- a/spec/endpoints/content_upload_spec.rb +++ b/spec/endpoints/content_upload_spec.rb @@ -1,21 +1,22 @@ +# frozen_string_literal: true describe DropboxApi::Endpoints::ContentUpload do - subject { described_class.new(DropboxApi::ConnectionBuilder.new("bearer")) } + subject { described_class.new(DropboxApi::ConnectionBuilder.new('bearer')) } context 'Content-Length header' do context 'for String body' do - it "is calculated and appended to headers" do + it 'is calculated and appended to headers' do body = IO.read(File.expand_path "#{__FILE__}/../../fixtures/img.png") _, headers = subject.build_request({}, body) - expect(headers['Content-Length']).to eq("3975") + expect(headers['Content-Length']).to eq('3975') end end context 'for File body' do - it "is calculated and appended to headers" do + it 'is calculated and appended to headers' do begin - content = "tested content" + content = 'tested content' file = Tempfile.new('dropbox_api') file << content @@ -34,7 +35,7 @@ _, headers = subject.build_request({}, body) - expect(headers).to_not have_key("Content-Length") + expect(headers).to_not have_key('Content-Length') end end end diff --git a/spec/endpoints/file_requests/create_file_request_spec.rb b/spec/endpoints/file_requests/create_file_request_spec.rb index 3888fc7d..dff3911b 100644 --- a/spec/endpoints/file_requests/create_file_request_spec.rb +++ b/spec/endpoints/file_requests/create_file_request_spec.rb @@ -1,17 +1,18 @@ -describe DropboxApi::Client, "#create_file_request" do +# frozen_string_literal: true +describe DropboxApi::Client, '#create_file_request' do let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :create_file_request } before :each do @client = DropboxApi::Client.new end - it "returns the new file request on success", :cassette => "create_file_request/success" do + it 'returns the new file request on success', cassette: 'create_file_request/success' do file_request = @client.create_file_request 'Arizona, baby', "#{path_prefix}/arizona_baby" expect(file_request).to be_a(DropboxApi::Metadata::FileRequest) - expect(file_request.title).to eq("Arizona, baby") + expect(file_request.title).to eq('Arizona, baby') end - it "raises something if wrong path", :cassette => "create_file_request/not_a_folder" do + it 'raises something if wrong path', cassette: 'create_file_request/not_a_folder' do expect { @client.create_file_request 'Arizona, baby', "#{path_prefix}/regular_file.txt" }.to raise_error(DropboxApi::Errors::CreateFileRequestError) diff --git a/spec/endpoints/files/copy_batch_check_spec.rb b/spec/endpoints/files/copy_batch_check_spec.rb index 22b143a9..ca91b4c0 100644 --- a/spec/endpoints/files/copy_batch_check_spec.rb +++ b/spec/endpoints/files/copy_batch_check_spec.rb @@ -1,19 +1,20 @@ -describe DropboxApi::Client, "#copy_batch_check" do +# frozen_string_literal: true +describe DropboxApi::Client, '#copy_batch_check' do before :each do @client = DropboxApi::Client.new end - it "returns all types of entries", :cassette => "copy_batch_check/complete" do - result = @client.copy_batch_check "dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsU" + it 'returns all types of entries', cassette: 'copy_batch_check/complete' do + result = @client.copy_batch_check 'dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsU' expect(result).to include(a_kind_of(DropboxApi::Metadata::Folder)) expect(result).to include(a_kind_of(DropboxApi::Metadata::File)) expect(result).to include(a_kind_of(DropboxApi::Errors::NotFoundError)) end - it "returns 'invalid_async_job_id' error", :cassette => "copy_batch_check/invalid_async_job_id" do + it "returns 'invalid_async_job_id' error", cassette: 'copy_batch_check/invalid_async_job_id' do expect { - @client.copy_batch_check "dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsE" + @client.copy_batch_check 'dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsE' }.to raise_error(DropboxApi::Errors::InvalidIdError) end end \ No newline at end of file diff --git a/spec/endpoints/files/copy_batch_spec.rb b/spec/endpoints/files/copy_batch_spec.rb index da95bb11..db34d432 100644 --- a/spec/endpoints/files/copy_batch_spec.rb +++ b/spec/endpoints/files/copy_batch_spec.rb @@ -1,26 +1,27 @@ -describe DropboxApi::Client, "#copy_batch" do +# frozen_string_literal: true +describe DropboxApi::Client, '#copy_batch' do let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :copy_batch } before :each do @client = DropboxApi::Client.new end - it "returns an async job id", :cassette => "copy_batch/success" do + it 'returns an async job id', cassette: 'copy_batch/success' do job_id = @client.copy_batch [{ - :from_path => "#{path_prefix}/regular_file.txt", - :to_path => "#{path_prefix}/regular_file_renamed.txt" + from_path: "#{path_prefix}/regular_file.txt", + to_path: "#{path_prefix}/regular_file_renamed.txt" }] expect(job_id) - .to eq("dbjid:AAA6b4uwc19nEau5k-OBI_h-hjrR7pNDaUA3_0hOwV-UZ2pkw_zXWp3FSuVZrQ0d9IXKGkwB5JdYI4mJZumLc6qZ") + .to eq('dbjid:AAA6b4uwc19nEau5k-OBI_h-hjrR7pNDaUA3_0hOwV-UZ2pkw_zXWp3FSuVZrQ0d9IXKGkwB5JdYI4mJZumLc6qZ') end - it "if autorename option is true, returns an async job id", :cassette => "copy_batch/autorename_success" do + it 'if autorename option is true, returns an async job id', cassette: 'copy_batch/autorename_success' do job_id = @client.copy_batch([{ - :from_path => "#{path_prefix}/regular_file_2.txt", - :to_path => "#{path_prefix}/regular_file_2_renamed.txt" - }], :autorename => true) + from_path: "#{path_prefix}/regular_file_2.txt", + to_path: "#{path_prefix}/regular_file_2_renamed.txt" + }], autorename: true) expect(job_id) - .to eq("dbjid:AABe-bOUUq5nrybciMJxIxaGAD16nGCKByGyY3Z_2m6kshGW903XTikVT3_5V6JQQu20p3QxoCfws7_hT40deF6q") + .to eq('dbjid:AABe-bOUUq5nrybciMJxIxaGAD16nGCKByGyY3Z_2m6kshGW903XTikVT3_5V6JQQu20p3QxoCfws7_hT40deF6q') end end diff --git a/spec/endpoints/files/copy_reference_get_spec.rb b/spec/endpoints/files/copy_reference_get_spec.rb index 52543014..85c19b39 100644 --- a/spec/endpoints/files/copy_reference_get_spec.rb +++ b/spec/endpoints/files/copy_reference_get_spec.rb @@ -1,34 +1,35 @@ -describe DropboxApi::Client, "#copy_reference_get" do +# frozen_string_literal: true +describe DropboxApi::Client, '#copy_reference_get' do before :each do @client = DropboxApi::Client.new end - context "on a file" do - it "returns a copy reference", :cassette => "copy_reference_get/success_file" do - result = @client.copy_reference_get "/file.txt" + context 'on a file' do + it 'returns a copy reference', cassette: 'copy_reference_get/success_file' do + result = @client.copy_reference_get '/file.txt' expect(result).to be_a(DropboxApi::Results::GetCopyReferenceResult) - expect(result.resource.name).to eq("file.txt") + expect(result.resource.name).to eq('file.txt') expect(result.copy_reference).to be_a(String) expect(result.expires).to be_a(Time) end end - context "on a folder" do - it "returns a copy reference", :cassette => "copy_reference_get/success_folder" do - result = @client.copy_reference_get("/folder") + context 'on a folder' do + it 'returns a copy reference', cassette: 'copy_reference_get/success_folder' do + result = @client.copy_reference_get('/folder') expect(result).to be_a(DropboxApi::Results::GetCopyReferenceResult) - expect(result.resource.name).to eq("folder") + expect(result.resource.name).to eq('folder') expect(result.copy_reference).to be_a(String) expect(result.expires).to be_a(Time) end end context "if the path doesn't exist" do - it "raises an error", :cassette => "copy_reference_get/not_found" do + it 'raises an error', cassette: 'copy_reference_get/not_found' do expect { - @client.copy_reference_get("/c.jpg") + @client.copy_reference_get('/c.jpg') }.to raise_error(DropboxApi::Errors::NotFoundError) end end diff --git a/spec/endpoints/files/copy_reference_save_spec.rb b/spec/endpoints/files/copy_reference_save_spec.rb index 4f9bd38d..8b3b41c7 100644 --- a/spec/endpoints/files/copy_reference_save_spec.rb +++ b/spec/endpoints/files/copy_reference_save_spec.rb @@ -1,66 +1,67 @@ -describe DropboxApi::Client, "#copy_reference_save" do +# frozen_string_literal: true +describe DropboxApi::Client, '#copy_reference_save' do before :each do @client = DropboxApi::Client.new # Taken from fixture (copy_reference_get/success_file.yml) - @copy_reference = "WI-v4zliNDByb3JwejZlNw" + @copy_reference = 'WI-v4zliNDByb3JwejZlNw' end - context "when a file is being referenced" do - it "returns the saved file", :cassette => "copy_reference_save/success_file" do - result = @client.copy_reference_save @copy_reference, "/copied-file.txt" + context 'when a file is being referenced' do + it 'returns the saved file', cassette: 'copy_reference_save/success_file' do + result = @client.copy_reference_save @copy_reference, '/copied-file.txt' expect(result).to be_a(DropboxApi::Results::SaveCopyReferenceResult) - expect(result.resource.name).to eq("copied-file.txt") + expect(result.resource.name).to eq('copied-file.txt') end end - context "when a folder is being referenced" do - it "returns the saved folder", :cassette => "copy_reference_save/success_folder" do + context 'when a folder is being referenced' do + it 'returns the saved folder', cassette: 'copy_reference_save/success_folder' do # Taken from fixture (copy_reference_get/success_folder.yml) - copy_reference = "WI-v42h5NWxnbDZ2enpjbw" - result = @client.copy_reference_save copy_reference, "/copied-folder" + copy_reference = 'WI-v42h5NWxnbDZ2enpjbw' + result = @client.copy_reference_save copy_reference, '/copied-folder' expect(result).to be_a(DropboxApi::Results::SaveCopyReferenceResult) - expect(result.resource.name).to eq("copied-folder") + expect(result.resource.name).to eq('copied-folder') end end - context "if the path is already in use by another resource" do - it "raises an error", :cassette => "copy_reference_save/conflict" do + context 'if the path is already in use by another resource' do + it 'raises an error', cassette: 'copy_reference_save/conflict' do expect { - @client.copy_reference_save @copy_reference, "/copied-file.txt" + @client.copy_reference_save @copy_reference, '/copied-file.txt' }.to raise_error(DropboxApi::Errors::FileConflictError) end end - context "if the copy reference is invalid" do - it "raises an error", :cassette => "copy_reference_save/invalid_reference" do + context 'if the copy reference is invalid' do + it 'raises an error', cassette: 'copy_reference_save/invalid_reference' do expect { - @client.copy_reference_save "invalid-reference", "/copied-file.txt" + @client.copy_reference_save 'invalid-reference', '/copied-file.txt' }.to raise_error(DropboxApi::Errors::InvalidCopyReferenceError) end end - context "if the path is malformed" do - it "raises an error", :cassette => "copy_reference_save/malformed_path" do + context 'if the path is malformed' do + it 'raises an error', cassette: 'copy_reference_save/malformed_path' do expect { - @client.copy_reference_save @copy_reference, "//copied-file.txt" + @client.copy_reference_save @copy_reference, '//copied-file.txt' }.to raise_error(DropboxApi::Errors::MalformedPathError) end end context "if the user doesn't have permission to save the copy reference" do - it "raises an error", :cassette => "copy_reference_save/no_permission" do + it 'raises an error', cassette: 'copy_reference_save/no_permission' do expect { - @client.copy_reference_save @copy_reference, "/copied-file.txt" + @client.copy_reference_save @copy_reference, '/copied-file.txt' }.to raise_error(DropboxApi::Errors::NoPermissionError) end end - context "if the referenced resource has been deleted" do - it "raises an error", :cassette => "copy_reference_save/not_found" do + context 'if the referenced resource has been deleted' do + it 'raises an error', cassette: 'copy_reference_save/not_found' do expect { - @client.copy_reference_save @copy_reference, "/copied-file.txt" + @client.copy_reference_save @copy_reference, '/copied-file.txt' }.to raise_error(DropboxApi::Errors::NotFoundError) end end diff --git a/spec/endpoints/files/copy_spec.rb b/spec/endpoints/files/copy_spec.rb index 3f854045..bda7bafb 100644 --- a/spec/endpoints/files/copy_spec.rb +++ b/spec/endpoints/files/copy_spec.rb @@ -1,24 +1,25 @@ -describe DropboxApi::Client, "#copy" do +# frozen_string_literal: true +describe DropboxApi::Client, '#copy' do before :each do @client = DropboxApi::Client.new end - it "returns the copied file on success", :cassette => "copy/success" do - file = @client.copy("/a.jpg", "/b.jpg") + it 'returns the copied file on success', cassette: 'copy/success' do + file = @client.copy('/a.jpg', '/b.jpg') expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("b.jpg") + expect(file.name).to eq('b.jpg') end - it "raises an error if the file can't be found", :cassette => "copy/not_found" do + it "raises an error if the file can't be found", cassette: 'copy/not_found' do expect { - @client.copy("/z.jpg", "/b.jpg") + @client.copy('/z.jpg', '/b.jpg') }.to raise_error(DropboxApi::Errors::NotFoundError) end - it "raises an error if the path is invalid", :cassette => "copy/malformed_path" do + it 'raises an error if the path is invalid', cassette: 'copy/malformed_path' do expect { - @client.copy("/../invalid_path.jpg", "/b.jpg") + @client.copy('/../invalid_path.jpg', '/b.jpg') }.to raise_error(DropboxApi::Errors::MalformedPathError) end end diff --git a/spec/endpoints/files/create_folder_batch_check_spec.rb b/spec/endpoints/files/create_folder_batch_check_spec.rb index 70fa7398..1b7350c9 100644 --- a/spec/endpoints/files/create_folder_batch_check_spec.rb +++ b/spec/endpoints/files/create_folder_batch_check_spec.rb @@ -1,19 +1,20 @@ -describe DropboxApi::Client, "#create_folder_batch_check" do +# frozen_string_literal: true +describe DropboxApi::Client, '#create_folder_batch_check' do before :each do @client = DropboxApi::Client.new end - it "returns mixed results with failure and success status for each entry", :cassette => "create_folder_batch_check/mixed_entries" do - async_result = @client.create_folder_batch_check("dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQE") + it 'returns mixed results with failure and success status for each entry', cassette: 'create_folder_batch_check/mixed_entries' do + async_result = @client.create_folder_batch_check('dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQE') expect(async_result).to include(a_kind_of(DropboxApi::Metadata::Folder)) expect(async_result).to include(a_kind_of(DropboxApi::Errors::MalformedPathError)) expect(async_result).to include(a_kind_of(DropboxApi::Errors::FolderConflictError)) end - it "raises an error with an invalid async job id", :cassette => "create_folder_batch_check/invalid_async_job_id" do + it 'raises an error with an invalid async job id', cassette: 'create_folder_batch_check/invalid_async_job_id' do expect { - @client.create_folder_batch_check("dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT") + @client.create_folder_batch_check('dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT') }.to raise_error(DropboxApi::Errors::InvalidIdError) end end diff --git a/spec/endpoints/files/create_folder_batch_spec.rb b/spec/endpoints/files/create_folder_batch_spec.rb index bfe316b3..7ab2c81a 100644 --- a/spec/endpoints/files/create_folder_batch_spec.rb +++ b/spec/endpoints/files/create_folder_batch_spec.rb @@ -1,40 +1,41 @@ -describe DropboxApi::Client, "#create_folder_batch" do +# frozen_string_literal: true +describe DropboxApi::Client, '#create_folder_batch' do before :each do @client = DropboxApi::Client.new end - it "returns the created folders synchronously", :cassette => "create_folder_batch/synchronous_result_success" do - result = @client.create_folder_batch ["/Create Batch", "/Create Batch 1"] + it 'returns the created folders synchronously', cassette: 'create_folder_batch/synchronous_result_success' do + result = @client.create_folder_batch ['/Create Batch', '/Create Batch 1'] expect(result.first).to be_a(DropboxApi::Metadata::Folder) expect(result.last).to be_a(DropboxApi::Metadata::Folder) end - it "returns async_job_id when large entries are passed", :cassette => "create_folder_batch/large_entries" do + it 'returns async_job_id when large entries are passed', cassette: 'create_folder_batch/large_entries' do paths = [] 100.times { |i| paths << "/Folder #{i}"} async_result = @client.create_folder_batch(paths) expect(async_result).to be_a(Hash) - expect(async_result).to have_key("async_job_id") + expect(async_result).to have_key('async_job_id') end - it "returns async_job_id when force_async is true", :cassette => "create_folder_batch/force_async_true" do - async_result = @client.create_folder_batch(["/Create Batch 2", "/Create Batch 3"], { :force_async => true }) + it 'returns async_job_id when force_async is true', cassette: 'create_folder_batch/force_async_true' do + async_result = @client.create_folder_batch(['/Create Batch 2', '/Create Batch 3'], { force_async: true }) expect(async_result).to be_a(Hash) - expect(async_result).to have_key("async_job_id") + expect(async_result).to have_key('async_job_id') end - it "when autorename is true, does not return error for repeated entries", :cassette => "create_folder_batch/autorename_true" do - result = @client.create_folder_batch(["/Create Batch 1", "/Create Batch 1"], { :autorename => true }) + it 'when autorename is true, does not return error for repeated entries', cassette: 'create_folder_batch/autorename_true' do + result = @client.create_folder_batch(['/Create Batch 1', '/Create Batch 1'], { autorename: true }) expect(result).not_to include(a_kind_of(DropboxApi::Errors::FolderConflictError)) end - it "raises error, when invalid option is passed", :cassette => "create_folder_batch/invalid_option" do + it 'raises error, when invalid option is passed', cassette: 'create_folder_batch/invalid_option' do expect { - @client.create_folder_batch(["/Create Batch 4", "/Create Batch 5"], { :async => true }) + @client.create_folder_batch(['/Create Batch 4', '/Create Batch 5'], { async: true }) }.to raise_error(ArgumentError) end end diff --git a/spec/endpoints/files/create_folder_spec.rb b/spec/endpoints/files/create_folder_spec.rb index 5498ef26..2398d92f 100644 --- a/spec/endpoints/files/create_folder_spec.rb +++ b/spec/endpoints/files/create_folder_spec.rb @@ -1,24 +1,25 @@ -describe DropboxApi::Client, "#create_folder" do +# frozen_string_literal: true +describe DropboxApi::Client, '#create_folder' do before :each do @client = DropboxApi::Client.new end - it "returns the new folder on success", :cassette => "create_folder/success" do - folder = @client.create_folder("/arizona_baby") + it 'returns the new folder on success', cassette: 'create_folder/success' do + folder = @client.create_folder('/arizona_baby') expect(folder).to be_a(DropboxApi::Metadata::Folder) - expect(folder.name).to eq("arizona_baby") + expect(folder.name).to eq('arizona_baby') end - it "raises an error if the name is invalid", :cassette => "create_folder/malformed_path" do + it 'raises an error if the name is invalid', cassette: 'create_folder/malformed_path' do expect { - @client.create_folder("/arizona\\baby") + @client.create_folder('/arizona\\baby') }.to raise_error(DropboxApi::Errors::MalformedPathError) end - it "raises an error if the resource causes a conflict", :cassette => "create_folder/conflict" do + it 'raises an error if the resource causes a conflict', cassette: 'create_folder/conflict' do expect { - @client.create_folder("/b.jpg") + @client.create_folder('/b.jpg') }.to raise_error(DropboxApi::Errors::FileConflictError) end end diff --git a/spec/endpoints/files/delete_batch_check_spec.rb b/spec/endpoints/files/delete_batch_check_spec.rb index 531ad5a3..e60d77c6 100644 --- a/spec/endpoints/files/delete_batch_check_spec.rb +++ b/spec/endpoints/files/delete_batch_check_spec.rb @@ -1,10 +1,11 @@ -describe DropboxApi::Client, "#delete_batch_check" do +# frozen_string_literal: true +describe DropboxApi::Client, '#delete_batch_check' do before :each do @client = DropboxApi::Client.new end - it "returns mixed results when complete", :cassette => "delete_batch_check/mixed_entries" do - async_result = @client.delete_batch_check("dbjid:AAC2JUPMEtK-kEg7QVrNEemnX-FfQkJ_0r_tJJ2UpHhwvrUGrpw19CH4U5cfZKWPLxLVJoKgffTOy_zSKk6W953h") + it 'returns mixed results when complete', cassette: 'delete_batch_check/mixed_entries' do + async_result = @client.delete_batch_check('dbjid:AAC2JUPMEtK-kEg7QVrNEemnX-FfQkJ_0r_tJJ2UpHhwvrUGrpw19CH4U5cfZKWPLxLVJoKgffTOy_zSKk6W953h') expect(async_result).to include(a_kind_of(DropboxApi::Metadata::Folder)) expect(async_result).to include(a_kind_of(DropboxApi::Metadata::File)) @@ -12,9 +13,9 @@ expect(async_result).to include(a_kind_of(DropboxApi::Errors::NotFoundError)) end - it "raises an error with an invalid async job id", :cassette => "delete_batch_check/invalid_async_job_id" do + it 'raises an error with an invalid async job id', cassette: 'delete_batch_check/invalid_async_job_id' do expect { - @client.delete_batch_check("dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT") + @client.delete_batch_check('dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT') }.to raise_error(DropboxApi::Errors::InvalidIdError) end end \ No newline at end of file diff --git a/spec/endpoints/files/delete_batch_spec.rb b/spec/endpoints/files/delete_batch_spec.rb index 304be3f2..e08c2cb0 100644 --- a/spec/endpoints/files/delete_batch_spec.rb +++ b/spec/endpoints/files/delete_batch_spec.rb @@ -1,23 +1,24 @@ -describe DropboxApi::Client, "#delete_batch" do +# frozen_string_literal: true +describe DropboxApi::Client, '#delete_batch' do before :each do @client = DropboxApi::Client.new end ### NOT ABLE TO GET ANYTHING OTHER THAN ASYNC JOB ID IN RESPONSE FROM DROPBOX ### - it "returns async_job_id for multiple entries", :cassette => "delete_batch/multiple_entry_success" do - entries = [{ :path => "/folder_to_delete_1" }, { :path => "/folder_to_delete_2" }] + it 'returns async_job_id for multiple entries', cassette: 'delete_batch/multiple_entry_success' do + entries = [{ path: '/folder_to_delete_1' }, { path: '/folder_to_delete_2' }] async_result = @client.delete_batch entries expect(async_result).to be_a(Hash) - expect(async_result).to have_key("async_job_id") + expect(async_result).to have_key('async_job_id') end - it "returns async_job_id for single entry too", :cassette => "delete_batch/single_entry_success" do - entries = [{ :path => "/folder_to_delete/file_to_delete.docx", :parent_rev => "1c0576c68d6" }] + it 'returns async_job_id for single entry too', cassette: 'delete_batch/single_entry_success' do + entries = [{ path: '/folder_to_delete/file_to_delete.docx', parent_rev: '1c0576c68d6' }] async_result = @client.delete_batch entries expect(async_result).to be_a(Hash) - expect(async_result).to have_key("async_job_id") + expect(async_result).to have_key('async_job_id') end end diff --git a/spec/endpoints/files/delete_spec.rb b/spec/endpoints/files/delete_spec.rb index 0e584906..03ac4c48 100644 --- a/spec/endpoints/files/delete_spec.rb +++ b/spec/endpoints/files/delete_spec.rb @@ -1,32 +1,33 @@ -describe DropboxApi::Client, "#delete" do +# frozen_string_literal: true +describe DropboxApi::Client, '#delete' do let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :delete } before :each do @client = DropboxApi::Client.new end - it "returns the deleted file", :cassette => "delete/success_file" do + it 'returns the deleted file', cassette: 'delete/success_file' do file = @client.delete "#{path_prefix}/will_be_deleted.txt" expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("will_be_deleted.txt") + expect(file.name).to eq('will_be_deleted.txt') end - it "won't delete the file if `parent_rev` doesn't match", :cassette => "delete/invalid_parent_rev" do + it "won't delete the file if `parent_rev` doesn't match", cassette: 'delete/invalid_parent_rev' do expect { - @client.delete "#{path_prefix}/wont_be_deleted.txt", :parent_rev => "1c0576c68d6" + @client.delete "#{path_prefix}/wont_be_deleted.txt", parent_rev: '1c0576c68d6' }.to raise_error(DropboxApi::Errors::FileConflictError) end - it "returns the deleted folder", :cassette => "delete/success_folder" do + it 'returns the deleted folder', cassette: 'delete/success_folder' do folder = @client.delete "#{path_prefix}/folder" expect(folder).to be_a(DropboxApi::Metadata::Folder) - expect(folder.name).to eq("folder") + expect(folder.name).to eq('folder') end - it "raises an error if the name is invalid", :cassette => "delete/not_found" do + it 'raises an error if the name is invalid', cassette: 'delete/not_found' do expect { - @client.delete "/unexisting folder" + @client.delete '/unexisting folder' }.to raise_error(DropboxApi::Errors::NotFoundError) end end diff --git a/spec/endpoints/files/download_spec.rb b/spec/endpoints/files/download_spec.rb index 660626e5..e538aa21 100644 --- a/spec/endpoints/files/download_spec.rb +++ b/spec/endpoints/files/download_spec.rb @@ -1,27 +1,28 @@ -describe DropboxApi::Client, "#download" do +# frozen_string_literal: true +describe DropboxApi::Client, '#download' do before :each do @client = DropboxApi::Client.new end - it "returns the file", :cassette => "download/success" do - file = @client.download "/file.txt" + it 'returns the file', cassette: 'download/success' do + file = @client.download '/file.txt' expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("file.txt") + expect(file.name).to eq('file.txt') end - it "yields the file contents", :cassette => "download/success" do - file_contents = "" - file = @client.download "/file.txt" do |chunk| - file_contents << chunk + it 'yields the file contents', cassette: 'download/success' do + file_contents = '' + file = @client.download '/file.txt' do |chunk| + file_contents = "#{file_contents}#{chunk}" end - expect(file_contents).to eq("Viva Rusia!\n") + expect(file_contents).to eq("Hola Leo!\n") end - it "raises an error if the name is invalid", :cassette => "download/not_found" do + it 'raises an error if the name is invalid', cassette: 'download/not_found' do expect { - @client.download("/c.jpg") + @client.download('/c.jpg') }.to raise_error(DropboxApi::Errors::NotFoundError) end end diff --git a/spec/endpoints/files/get_metadata_spec.rb b/spec/endpoints/files/get_metadata_spec.rb index ca7a957b..20b807da 100644 --- a/spec/endpoints/files/get_metadata_spec.rb +++ b/spec/endpoints/files/get_metadata_spec.rb @@ -1,53 +1,54 @@ -describe DropboxApi::Client, "#get_metadata" do +# frozen_string_literal: true +describe DropboxApi::Client, '#get_metadata' do let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :get_metadata } before :each do @client = DropboxApi::Client.new end - it "may return a `File`", :cassette => "get_metadata/success_file" do + it 'may return a `File`', cassette: 'get_metadata/success_file' do file = @client.get_metadata("#{path_prefix}/file.txt") expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("file.txt") + expect(file.name).to eq('file.txt') end - it "will parse time specific fields", :cassette => "get_metadata/success_file" do + it 'will parse time specific fields', cassette: 'get_metadata/success_file' do file = @client.get_metadata("#{path_prefix}/file.txt") - expect(file.client_modified).to eq(Time.new(1988, 12, 8, 1, 1, 0, "+00:00")) + expect(file.client_modified).to eq(Time.new(1988, 12, 8, 1, 1, 0, '+00:00')) end - it "may return a `Folder`", :cassette => "get_metadata/success_folder" do + it 'may return a `Folder`', cassette: 'get_metadata/success_folder' do folder = @client.get_metadata("#{path_prefix}/folder") expect(folder).to be_a(DropboxApi::Metadata::Folder) - expect(folder.name).to eq("folder") + expect(folder.name).to eq('folder') end - it "raises an error if the path is wrong", :cassette => "get_metadata/not_found" do + it 'raises an error if the path is wrong', cassette: 'get_metadata/not_found' do expect { @client.get_metadata("#{path_prefix}/unexisting_folder") }.to raise_error(DropboxApi::Errors::NotFoundError) end - it "raises an error if an invalid option is given" do + it 'raises an error if an invalid option is given' do expect { - @client.get_metadata("#{path_prefix}/file.txt", :invalid_option => true) + @client.get_metadata("#{path_prefix}/file.txt", invalid_option: true) }.to raise_error ArgumentError end - context "on a deleted file" do - it "raises an error", :cassette => "get_metadata/deleted" do + context 'on a deleted file' do + it 'raises an error', cassette: 'get_metadata/deleted' do expect { @client.get_metadata("#{path_prefix}/deleted_file.txt") }.to raise_error(DropboxApi::Errors::NotFoundError) end - it "with `:include_deleted`, returns a `File`", :cassette => "get_metadata/success_deleted" do - file = @client.get_metadata("#{path_prefix}/deleted_file.txt", :include_deleted => true) + it 'with `:include_deleted`, returns a `File`', cassette: 'get_metadata/success_deleted' do + file = @client.get_metadata("#{path_prefix}/deleted_file.txt", include_deleted: true) expect(file).to be_a(DropboxApi::Metadata::Deleted) - expect(file.name).to eq("deleted_file.txt") + expect(file.name).to eq('deleted_file.txt') end end end diff --git a/spec/endpoints/files/get_preview_spec.rb b/spec/endpoints/files/get_preview_spec.rb index 8878d5f8..c2436ee6 100644 --- a/spec/endpoints/files/get_preview_spec.rb +++ b/spec/endpoints/files/get_preview_spec.rb @@ -1,18 +1,19 @@ -describe DropboxApi::Client, "#get_preview" do +# frozen_string_literal: true +describe DropboxApi::Client, '#get_preview' do before :each do @client = DropboxApi::Client.new end - it "returns the file", :cassette => "get_preview/success" do - file = @client.get_preview("/file.docx") + it 'returns the file', cassette: 'get_preview/success' do + file = @client.get_preview('/file.docx') expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("file.docx") + expect(file.name).to eq('file.docx') end - it "raises an error if the name is invalid", :cassette => "get_preview/not_found" do + it 'raises an error if the name is invalid', cassette: 'get_preview/not_found' do expect { - @client.get_preview("/unknown_file.jpg") + @client.get_preview('/unknown_file.jpg') }.to raise_error(DropboxApi::Errors::NotFoundError) end end diff --git a/spec/endpoints/files/get_temporary_link_spec.rb b/spec/endpoints/files/get_temporary_link_spec.rb index 5cb72ae1..49d36b17 100644 --- a/spec/endpoints/files/get_temporary_link_spec.rb +++ b/spec/endpoints/files/get_temporary_link_spec.rb @@ -1,18 +1,19 @@ -describe DropboxApi::Client, "#get_temporary_link" do +# frozen_string_literal: true +describe DropboxApi::Client, '#get_temporary_link' do before :each do @client = DropboxApi::Client.new end - it "returns a GetTemporaryLinkResult with file and link", :cassette => "get_temporary_link/success" do - result = @client.get_temporary_link "/img.png" + it 'returns a GetTemporaryLinkResult with file and link', cassette: 'get_temporary_link/success' do + result = @client.get_temporary_link '/img.png' expect(result).to be_a(DropboxApi::Results::GetTemporaryLinkResult) - expect(result.file.name).to eq("img.png") + expect(result.file.name).to eq('img.png') end - it "raises an error if the file can't be found", :cassette => "get_temporary_link/not_found" do + it "raises an error if the file can't be found", cassette: 'get_temporary_link/not_found' do expect { - @client.get_preview "/unknown_file.jpg" + @client.get_preview '/unknown_file.jpg' }.to raise_error(DropboxApi::Errors::NotFoundError) end end diff --git a/spec/endpoints/files/get_thumbnail_batch_spec.rb b/spec/endpoints/files/get_thumbnail_batch_spec.rb index a314d9c2..30145e73 100644 --- a/spec/endpoints/files/get_thumbnail_batch_spec.rb +++ b/spec/endpoints/files/get_thumbnail_batch_spec.rb @@ -1,27 +1,28 @@ -describe DropboxApi::Client, "#get_thumbnail_batch" do +# frozen_string_literal: true +describe DropboxApi::Client, '#get_thumbnail_batch' do let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :get_thumbnail_batch } before :each do @client = DropboxApi::Client.new end - it "returns files", :cassette => "get_thumbnail_batch/success" do + it 'returns files', cassette: 'get_thumbnail_batch/success' do result = @client.get_thumbnail_batch ["#{path_prefix}/img.png"] entry = result.entries.first expect(entry.metadata).to be_a(DropboxApi::Metadata::File) expect(entry.thumbnail).to be_a(String) - expect(entry.metadata.name).to eq("img.png") + expect(entry.metadata.name).to eq('img.png') end - it "includes an error entry if the file can't be found", :cassette => "get_thumbnail_batch/not_found" do + it "includes an error entry if the file can't be found", cassette: 'get_thumbnail_batch/not_found' do result = @client.get_thumbnail_batch ["#{path_prefix}/unknown_file.jpg"] expect(result.entries.first).to be_a(DropboxApi::Errors::NotFoundError) end - it "raises an argument error with invalid options" do + it 'raises an argument error with invalid options' do expect { - @client.get_thumbnail_batch ["#{path_prefix}/img.png"], :invalid_arg => "value" + @client.get_thumbnail_batch ["#{path_prefix}/img.png"], invalid_arg: 'value' }.to raise_error(ArgumentError) end end diff --git a/spec/endpoints/files/get_thumbnail_spec.rb b/spec/endpoints/files/get_thumbnail_spec.rb index ad45bb94..450b9a95 100644 --- a/spec/endpoints/files/get_thumbnail_spec.rb +++ b/spec/endpoints/files/get_thumbnail_spec.rb @@ -1,24 +1,25 @@ -describe DropboxApi::Client, "#get_thumbnail" do +# frozen_string_literal: true +describe DropboxApi::Client, '#get_thumbnail' do before :each do @client = DropboxApi::Client.new end - it "returns a file", :cassette => "get_thumbnail/success" do - file = @client.get_thumbnail "/img.png" + it 'returns a file', cassette: 'get_thumbnail/success' do + file = @client.get_thumbnail '/img.png' expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("img.png") + expect(file.name).to eq('img.png') end - it "raises an error if the file can't be found", :cassette => "get_thumbnail/not_found" do + it "raises an error if the file can't be found", cassette: 'get_thumbnail/not_found' do expect { - @client.get_thumbnail "/unknown_file.jpg" + @client.get_thumbnail '/unknown_file.jpg' }.to raise_error(DropboxApi::Errors::NotFoundError) end - it "raises an argument error with invalid options" do + it 'raises an argument error with invalid options' do expect { - @client.get_thumbnail "/img.png", :invalid_arg => "value" + @client.get_thumbnail '/img.png', invalid_arg: 'value' }.to raise_error(ArgumentError) end end diff --git a/spec/endpoints/files/list_folder_continue_spec.rb b/spec/endpoints/files/list_folder_continue_spec.rb index ea36cbfe..32e1f9cc 100644 --- a/spec/endpoints/files/list_folder_continue_spec.rb +++ b/spec/endpoints/files/list_folder_continue_spec.rb @@ -1,17 +1,18 @@ -describe DropboxApi::Client, "#list_folder_continue" do +# frozen_string_literal: true +describe DropboxApi::Client, '#list_folder_continue' do before :each do @client = DropboxApi::Client.new end before :each do - VCR.use_cassette("list_folder_continue/list_folder") do - result = @client.list_folder "/folder" + VCR.use_cassette('list_folder_continue/list_folder') do + result = @client.list_folder '/folder' expect(result.has_more?).to be_truthy @cursor = result.cursor end end - it "returns a ListFolderResult", :cassette => "list_folder_continue/success" do + it 'returns a ListFolderResult', cassette: 'list_folder_continue/success' do result = @client.list_folder_continue(@cursor) expect(result).to be_a(DropboxApi::Results::ListFolderResult) diff --git a/spec/endpoints/files/list_folder_get_latest_cursor_spec.rb b/spec/endpoints/files/list_folder_get_latest_cursor_spec.rb index d3570a30..3780ab91 100644 --- a/spec/endpoints/files/list_folder_get_latest_cursor_spec.rb +++ b/spec/endpoints/files/list_folder_get_latest_cursor_spec.rb @@ -1,17 +1,18 @@ -describe DropboxApi::Client, "#list_folder_get_latest_cursor" do +# frozen_string_literal: true +describe DropboxApi::Client, '#list_folder_get_latest_cursor' do before :each do @client = DropboxApi::Client.new end before :each do - VCR.use_cassette "list_folder_get_latest_cursor/list_folder" do - result = @client.list_folder "/folder" + VCR.use_cassette 'list_folder_get_latest_cursor/list_folder' do + result = @client.list_folder '/folder' @cursor = result.cursor end end - it "returns a ListFolderGetLatestCursorResult", :cassette => "list_folder_get_latest_cursor/success" do - result = @client.list_folder_get_latest_cursor :path => "/folder" + it 'returns a ListFolderGetLatestCursorResult', cassette: 'list_folder_get_latest_cursor/success' do + result = @client.list_folder_get_latest_cursor path: '/folder' expect(result) .to be_a(DropboxApi::Results::ListFolderGetLatestCursorResult) diff --git a/spec/endpoints/files/list_folder_longpoll_spec.rb b/spec/endpoints/files/list_folder_longpoll_spec.rb index af49e399..daeef590 100644 --- a/spec/endpoints/files/list_folder_longpoll_spec.rb +++ b/spec/endpoints/files/list_folder_longpoll_spec.rb @@ -1,29 +1,37 @@ -describe DropboxApi::Client, "#list_folder_longpoll" do +require 'byebug' + +# frozen_string_literal: true +describe DropboxApi::Client, '#list_folder_longpoll' do + let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :list_folder_longpoll } before :each do @client = DropboxApi::Client.new end before :each do - VCR.use_cassette("list_folder_longpoll/list_folder") do - @cursor = @client.list_folder("").cursor + VCR.use_cassette('list_folder_longpoll/list_folder') do + @cursor = @client.list_folder(path_prefix).cursor end end - it "returns a ListFolderLongpollResult", :cassette => "list_folder_longpoll/success" do - result = @client.list_folder_longpoll @cursor + it 'returns a ListFolderLongpollResult', cassette: 'list_folder_longpoll/success' do + result = nil + [ + Thread.new { + result = @client.list_folder_longpoll @cursor + }, + Thread.new { + sleep 1 # make sure the other request had time to start + @client.upload("#{path_prefix}/duck.txt", 'Quack!') + } + ].each(&:join) expect(result).to be_a(DropboxApi::Results::ListFolderLongpollResult) - end - - it "indicates if there're changes", :cassette => "list_folder_longpoll/success" do - result = @client.list_folder_longpoll @cursor - expect(result.changes).to be_truthy end - it "raises an error with an invalid cursor", :cassette => "list_folder_longpoll/reset" do + it 'raises an error with an invalid cursor', cassette: 'list_folder_longpoll/reset' do expect { - @client.list_folder_longpoll "I believe in the blerch" + @client.list_folder_longpoll 'I believe in the blerch' }.to raise_error DropboxApi::Errors::HttpError end end diff --git a/spec/endpoints/files/list_folder_spec.rb b/spec/endpoints/files/list_folder_spec.rb index 3cff1c5c..eb76f0a2 100644 --- a/spec/endpoints/files/list_folder_spec.rb +++ b/spec/endpoints/files/list_folder_spec.rb @@ -1,42 +1,69 @@ -describe DropboxApi::Client, "#list_folder" do +# frozen_string_literal: true +describe DropboxApi::Client, '#list_folder' do let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :list_folder } before :each do @client = DropboxApi::Client.new end - it "returns a ListFolderResult", :cassette => "list_folder/success" do - result = @client.list_folder "" + it 'returns a ListFolderResult', cassette: 'list_folder/success' do + result = @client.list_folder '' expect(result).to be_a(DropboxApi::Results::ListFolderResult) end - it "raises an error if the file can't be found", :cassette => "list_folder/not_found" do + it "raises an error if the file can't be found", cassette: 'list_folder/not_found' do expect { - @client.list_folder "/unexisting_folder" + @client.list_folder '/unexisting_folder' }.to raise_error(DropboxApi::Errors::NotFoundError) end - it "returns all entries as metadata objects", :cassette => "list_folder/success" do - result = @client.list_folder "" + it 'returns all entries as metadata objects', cassette: 'list_folder/success' do + result = @client.list_folder '' result.entries.each do |resource| expect(resource).to be_a(DropboxApi::Metadata::Base) end end - it "lists entries in shared folder if given", :cassette => "list_folder/success_shared_folder" do - result = @client.list_shared_links(:path => "#{path_prefix}/shared_folder") - result = @client.list_folder "", :shared_link => result.links.first.url + it 'lists entries in shared folder if given', cassette: 'list_folder/success_shared_folder' do + result = @client.list_shared_links(path: "#{path_prefix}/shared_folder") + result = @client.list_folder '', shared_link: result.links.first.url result.entries.each do |resource| expect(resource).to be_a(DropboxApi::Metadata::Base) end - expect(result.entries.map(&:name).inspect).to include("cow.txt") + expect(result.entries.map(&:name).inspect).to include('cow.txt') end - it "raises an argument error with invalid options" do + it 'raises an argument error with invalid options' do expect { - @client.list_folder "/img.png", :invalid_arg => "value" + @client.list_folder '/img.png', invalid_arg: 'value' }.to raise_error(ArgumentError) end + + context 'with a namespace ID' do + it 'works with a namespace_id', cassette: 'list_folder/success_with_namespace_id' do + @client.namespace_id = 70721710 + @client.list_folder '/dropbox_api_fixtures' + end + + it 'fails with an invalid namespace ID', cassette: 'list_folder/invalid_namespace_id' do + @client.namespace_id = 938429923 + + expect do + @client.list_folder '/dropbox_api_fixtures' + end.to raise_error(DropboxApi::Errors::HttpError) + end + + it 'works if namespace ID is unset ', cassette: 'list_folder/unset_namespace_id' do + @client.namespace_id = 70721710 + + # we expect this to use a namespace ID + @client.list_folder '/dropbox_api_fixtures' + + @client.namespace_id = nil + # we expect the next not to use any namespace ID + @client.list_folder '/dropbox_api_fixtures' + end + end end diff --git a/spec/endpoints/files/list_revisions_spec.rb b/spec/endpoints/files/list_revisions_spec.rb index ef3a39af..a7bd6539 100644 --- a/spec/endpoints/files/list_revisions_spec.rb +++ b/spec/endpoints/files/list_revisions_spec.rb @@ -1,30 +1,31 @@ -describe DropboxApi::Client, "#list_revisions" do +# frozen_string_literal: true +describe DropboxApi::Client, '#list_revisions' do before :each do @client = DropboxApi::Client.new end - it "returns a ListRevisionsResult", :cassette => "list_revisions/success" do - result = @client.list_revisions "/file.txt" + it 'returns a ListRevisionsResult', cassette: 'list_revisions/success' do + result = @client.list_revisions '/file.txt' expect(result).to be_a(DropboxApi::Results::ListRevisionsResult) end - it "raises an error if the file can't be found", :cassette => "list_revisions/not_found" do + it "raises an error if the file can't be found", cassette: 'list_revisions/not_found' do expect { - @client.list_revisions "/unexisting_file" + @client.list_revisions '/unexisting_file' }.to raise_error(DropboxApi::Errors::NotFoundError) end - it "returns all revisions as metadata objects", :cassette => "list_revisions/success" do - result = @client.list_revisions "/file.txt" + it 'returns all revisions as metadata objects', cassette: 'list_revisions/success' do + result = @client.list_revisions '/file.txt' result.entries.each do |resource| expect(resource).to be_a(DropboxApi::Metadata::Base) end end - it "indicates if the file has been deleted", :cassette => "list_revisions/success" do - result = @client.list_revisions "/file.txt" + it 'indicates if the file has been deleted', cassette: 'list_revisions/success' do + result = @client.list_revisions '/file.txt' expect(result.is_deleted?).to be_truthy end diff --git a/spec/endpoints/files/move_spec.rb b/spec/endpoints/files/move_spec.rb index 9c9dc7b3..72c629cb 100644 --- a/spec/endpoints/files/move_spec.rb +++ b/spec/endpoints/files/move_spec.rb @@ -1,32 +1,33 @@ -describe DropboxApi::Client, "#move" do +# frozen_string_literal: true +describe DropboxApi::Client, '#move' do before :each do @client = DropboxApi::Client.new end - it "returns the moved file on success", :cassette => "move/success_file" do - file = @client.move("/img.png", "/image.png") + it 'returns the moved file on success', cassette: 'move/success_file' do + file = @client.move('/img.png', '/image.png') expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("image.png") + expect(file.name).to eq('image.png') end - it "returns the moved folder on success", :cassette => "move/success_folder" do - file = @client.move("/folder", "/test/folder") + it 'returns the moved folder on success', cassette: 'move/success_folder' do + file = @client.move('/folder', '/test/folder') expect(file).to be_a(DropboxApi::Metadata::Folder) - expect(file.name).to eq("folder") + expect(file.name).to eq('folder') end - it "renames the moved file if required", :cassette => "move/success_rename" do - file = @client.move("/a.jpg", "/photo.jpg", :autorename => true) + it 'renames the moved file if required', cassette: 'move/success_rename' do + file = @client.move('/a.jpg', '/photo.jpg', autorename: true) expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("photo (1).jpg") + expect(file.name).to eq('photo (1).jpg') end - it "raises an error if the file can't be found", :cassette => "move/not_found" do + it "raises an error if the file can't be found", cassette: 'move/not_found' do expect { - @client.move("/z.jpg", "/b.jpg") + @client.move('/z.jpg', '/b.jpg') }.to raise_error(DropboxApi::Errors::NotFoundError) end end diff --git a/spec/endpoints/files/permanently_delete_spec.rb b/spec/endpoints/files/permanently_delete_spec.rb index bec9a99e..4fbf0b98 100644 --- a/spec/endpoints/files/permanently_delete_spec.rb +++ b/spec/endpoints/files/permanently_delete_spec.rb @@ -1,10 +1,11 @@ -describe DropboxApi::Client, "#permanently_delete" do +# frozen_string_literal: true +describe DropboxApi::Client, '#permanently_delete' do let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :permanently_delete } before :each do @client = DropboxApi::Client.new end - it "can't be tested without a Dropbox Business account :(", :cassette => "permanently_delete/invalid_account" do + it "can't be tested without a Dropbox Business account :(", cassette: 'permanently_delete/invalid_account' do expect { @client.permanently_delete "#{path_prefix}/file.txt" }.to raise_error(DropboxApi::Errors::HttpError) diff --git a/spec/endpoints/files/restore_spec.rb b/spec/endpoints/files/restore_spec.rb index 9f06927a..5f8c25c8 100644 --- a/spec/endpoints/files/restore_spec.rb +++ b/spec/endpoints/files/restore_spec.rb @@ -1,18 +1,19 @@ -describe DropboxApi::Client, "#restore" do +# frozen_string_literal: true +describe DropboxApi::Client, '#restore' do before :each do @client = DropboxApi::Client.new end - it "returns the restored file on success", :cassette => "restore/success" do + it 'returns the restored file on success', cassette: 'restore/success' do # "/file.txt" has two revisions: ["1a6b24061bdd", "1a6a24061bdd"] - file = @client.restore("/file.txt", "1a6a24061bdd") + file = @client.restore('/file.txt', '1a6a24061bdd') expect(file).to be_a(DropboxApi::Metadata::File) end - it "raises an error with an invalid revision", :cassette => "restore/invalid_revision" do + it 'raises an error with an invalid revision', cassette: 'restore/invalid_revision' do expect { - file = @client.restore("/file.txt", "1a6a24061000") + file = @client.restore('/file.txt', '1a6a24061000') }.to raise_error(DropboxApi::Errors::InvalidRevisionError) end end diff --git a/spec/endpoints/files/save_url_check_job_status_spec.rb b/spec/endpoints/files/save_url_check_job_status_spec.rb index f9d5d812..f4bebfeb 100644 --- a/spec/endpoints/files/save_url_check_job_status_spec.rb +++ b/spec/endpoints/files/save_url_check_job_status_spec.rb @@ -1,23 +1,24 @@ -describe DropboxApi::Client, "#save_url_check_job_status" do +# frozen_string_literal: true +describe DropboxApi::Client, '#save_url_check_job_status' do before :each do @client = DropboxApi::Client.new end - it "returns the saved file if job completed", :cassette => "save_url_check_job_status/complete" do - result = @client.save_url_check_job_status "VofXAX8DO1sAAAAAAAAD_Q" + it 'returns the saved file if job completed', cassette: 'save_url_check_job_status/complete' do + result = @client.save_url_check_job_status 'VofXAX8DO1sAAAAAAAAD_Q' expect(result).to be_a(DropboxApi::Metadata::File) end - it "returns :in_progress if job not completed", :cassette => "save_url_check_job_status/in_progress" do - save_url_result = @client.save_url("/file.zip", "http://ipv4.download.thinkbroadband.com/1GB.zip") + it 'returns :in_progress if job not completed', cassette: 'save_url_check_job_status/in_progress' do + save_url_result = @client.save_url('/file.zip', 'http://ipv4.download.thinkbroadband.com/1GB.zip') status = @client.save_url_check_job_status save_url_result.async_job_id expect(status).to eq(:in_progress) end - it "returns a descriptive error if the job failed", :cassette => "save_url_check_job_status/failed" do - save_url_result = @client.save_url("/missing_file.zip", "http://ipv4.download.thinkbroadband.com/not_found.zip") + it 'returns a descriptive error if the job failed', cassette: 'save_url_check_job_status/failed' do + save_url_result = @client.save_url('/missing_file.zip', 'http://ipv4.download.thinkbroadband.com/not_found.zip') # sleep 30 # We may need to wait until job completes to get its failure status = @client.save_url_check_job_status save_url_result.async_job_id diff --git a/spec/endpoints/files/save_url_spec.rb b/spec/endpoints/files/save_url_spec.rb index da25635d..74996421 100644 --- a/spec/endpoints/files/save_url_spec.rb +++ b/spec/endpoints/files/save_url_spec.rb @@ -1,23 +1,24 @@ -describe DropboxApi::Client, "#save_url" do +# frozen_string_literal: true +describe DropboxApi::Client, '#save_url' do before :each do @client = DropboxApi::Client.new end - it "returns the saved file on success", :cassette => "save_url/success_dropbox" do - result = @client.save_url("/photo_1.jpg", "https://www.dropbox.com/s/834xngq25alcwsi/IMG_8998.JPG?dl=0") + it 'returns the saved file on success', cassette: 'save_url/success_dropbox' do + result = @client.save_url('/photo_1.jpg', 'https://www.dropbox.com/s/834xngq25alcwsi/IMG_8998.JPG?dl=0') - expect(result.async_job_id).to eq("VofXAX8DO1sAAAAAAAAD_Q") + expect(result.async_job_id).to eq('VofXAX8DO1sAAAAAAAAD_Q') end - it "returns the saved file on success", :cassette => "save_url/success_external" do - result = @client.save_url("/photo_2.jpg", "https://static1.squarespace.com/static/518aa4bee4b050d373a7e8a2/t/558add71e4b062927077adc6/1435164035794/photo-1427348693976-99e4aca06bb9.jpg") + it 'returns the saved file on success', cassette: 'save_url/success_external' do + result = @client.save_url('/photo_2.jpg', 'https://static1.squarespace.com/static/518aa4bee4b050d373a7e8a2/t/558add71e4b062927077adc6/1435164035794/photo-1427348693976-99e4aca06bb9.jpg') - expect(result.async_job_id).to eq("VofXAX8DO1sAAAAAAAAD_w") + expect(result.async_job_id).to eq('VofXAX8DO1sAAAAAAAAD_w') end - it "raises an error with an invalid URL", :cassette => "save_url/invalid_url" do + it 'raises an error with an invalid URL', cassette: 'save_url/invalid_url' do expect { - file = @client.save_url("/photo_3.jpg", "1a6a24061000") + file = @client.save_url('/photo_3.jpg', '1a6a24061000') }.to raise_error(DropboxApi::Errors::InvalidUrlError) end end diff --git a/spec/endpoints/files/search_continue_spec.rb b/spec/endpoints/files/search_continue_spec.rb new file mode 100644 index 00000000..7f69b45e --- /dev/null +++ b/spec/endpoints/files/search_continue_spec.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true +describe DropboxApi::Client, '#search_continue' do + before :each do + @client = DropboxApi::Client.new + end + + before :each do + VCR.use_cassette('search_continue/search') do + result = @client.search 'file', { max_results: 1 } + expect(result.has_more?).to be_truthy + @cursor = result.cursor + end + end + + it 'returns a SearchResult', cassette: 'search_continue/success' do + result = @client.search_continue(@cursor) + + expect(result).to be_a(DropboxApi::Results::SearchV2Result) + end +end diff --git a/spec/endpoints/files/search_spec.rb b/spec/endpoints/files/search_spec.rb index c7db3110..ad27e4f7 100644 --- a/spec/endpoints/files/search_spec.rb +++ b/spec/endpoints/files/search_spec.rb @@ -1,19 +1,25 @@ -describe DropboxApi::Client, "#search" do +# frozen_string_literal: true +describe DropboxApi::Client, '#search' do before :each do @client = DropboxApi::Client.new end - it "returns a list of matching results", :cassette => "search/success" do - result = @client.search("image.png") + it 'returns a list of matching results', cassette: 'search/success' do + result = @client.search('findable_file') - expect(result).to be_a(DropboxApi::Results::SearchResult) - file = result.matches.first.resource - expect(file.name).to eq("image.png") + expect(result).to be_a(DropboxApi::Results::SearchV2Result) + match = result.matches.first + expect(match.resource.name).to eq('findable_file.txt') + expect(match.match_type).to eq(:filename) end - it "raises an error if the file can't be found", :cassette => "search/not_found" do - expect { - @client.search("/image.png", "/bad_folder") - }.to raise_error(DropboxApi::Errors::NotFoundError) + it "raises an error if the file can't be found", + cassette: 'search/not_found' do + options = DropboxApi::Metadata::SearchOptions.new( + { 'path' => '/bad_folder' } + ) + + result = @client.search('/image.png', options) + expect(result.matches).to be_empty end end diff --git a/spec/endpoints/files/upload_session_append_v2_spec.rb b/spec/endpoints/files/upload_session_append_v2_spec.rb index c57659bc..4041abfd 100644 --- a/spec/endpoints/files/upload_session_append_v2_spec.rb +++ b/spec/endpoints/files/upload_session_append_v2_spec.rb @@ -1,10 +1,11 @@ #encoding: utf-8 -describe DropboxApi::Client, "#upload_session_append_v2" do +# frozen_string_literal: true +describe DropboxApi::Client, '#upload_session_append_v2' do before :each do @client = DropboxApi::Client.new end - it 'can be used to append an upload', :cassette => 'upload_session_append_v2/success' do + it 'can be used to append an upload', cassette: 'upload_session_append_v2/success' do chunks = ['123456789', 'Olá Dropbox!'] cursor = @client.upload_session_start(chunks.first) @@ -19,19 +20,19 @@ expect { @client.upload_session_finish(cursor, commit) }.not_to raise_error end - it "will raise error if the cursor can't be found", :cassette => "upload_session_append_v2/not_found" do + it "will raise error if the cursor can't be found", cassette: 'upload_session_append_v2/not_found' do cursor = DropboxApi::Metadata::UploadSessionCursor.new({ - "session_id" => "INVALID_CURSOR", - "offset" => 0 + 'session_id' => 'INVALID_CURSOR', + 'offset' => 0 }) expect { - @client.upload_session_append_v2(cursor, "Hello Dropbox!") + @client.upload_session_append_v2(cursor, 'Hello Dropbox!') }.to raise_error(DropboxApi::Errors::NotFoundError) end - it "will raise error if the offset is wrong", :cassette => "upload_session_append_v2/offset_error" do - chunk = "123456789" + it 'will raise error if the offset is wrong', cassette: 'upload_session_append_v2/offset_error' do + chunk = '123456789' cursor = @client.upload_session_start(chunk) @@ -39,7 +40,7 @@ cursor.instance_variable_set :@offset, 42 expect { - @client.upload_session_append_v2(cursor, "Hello Dropbox!") + @client.upload_session_append_v2(cursor, 'Hello Dropbox!') }.to raise_error(DropboxApi::Errors::UploadSessionOffsetError) end end diff --git a/spec/endpoints/files/upload_session_finish_spec.rb b/spec/endpoints/files/upload_session_finish_spec.rb index 1ca931d1..4542b48c 100644 --- a/spec/endpoints/files/upload_session_finish_spec.rb +++ b/spec/endpoints/files/upload_session_finish_spec.rb @@ -1,18 +1,19 @@ -describe DropboxApi::Client, "#upload_session_finish" do +# frozen_string_literal: true +describe DropboxApi::Client, '#upload_session_finish' do before :each do @client = DropboxApi::Client.new end - it "will create a file", :cassette => "upload_session_finish/success" do - cursor = @client.upload_session_start("Hello Dropbox!") + it 'will create a file', cassette: 'upload_session_finish/success' do + cursor = @client.upload_session_start('Hello Dropbox!') commit = DropboxApi::Metadata::CommitInfo.new({ - "path" => "/Homework/math/Matrices.txt", - "mode" => :add + 'path' => '/Homework/math/Matrices.txt', + 'mode' => :add }) file = @client.upload_session_finish(cursor, commit) expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("Matrices.txt") + expect(file.name).to eq('Matrices.txt') end end diff --git a/spec/endpoints/files/upload_session_start_spec.rb b/spec/endpoints/files/upload_session_start_spec.rb index 7f8a09d2..d46fe034 100644 --- a/spec/endpoints/files/upload_session_start_spec.rb +++ b/spec/endpoints/files/upload_session_start_spec.rb @@ -1,12 +1,13 @@ -describe DropboxApi::Client, "#upload_session_start" do +# frozen_string_literal: true +describe DropboxApi::Client, '#upload_session_start' do before :each do @client = DropboxApi::Client.new end - it "returns a session", :cassette => "upload_session_start/success" do - cursor = @client.upload_session_start("Hello Dropbox!") + it 'returns a session', cassette: 'upload_session_start/success' do + cursor = @client.upload_session_start('Hello Dropbox!') expect(cursor).to be_a(DropboxApi::Metadata::UploadSessionCursor) - expect(cursor.session_id).to eq("AAAAAAAMOCK_SESSION_ID") + expect(cursor.session_id).to eq('AAAAAAAMOCK_SESSION_ID') end end diff --git a/spec/endpoints/files/upload_spec.rb b/spec/endpoints/files/upload_spec.rb index 7436316f..9dd8a063 100644 --- a/spec/endpoints/files/upload_spec.rb +++ b/spec/endpoints/files/upload_spec.rb @@ -1,76 +1,77 @@ -describe DropboxApi::Client, "#upload" do +# frozen_string_literal: true +describe DropboxApi::Client, '#upload' do let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :upload } before :each do @client = DropboxApi::Client.new end - it "uploads a file", :cassette => "upload/success" do - file = @client.upload("#{path_prefix}/file.txt", "Hello Dropbox!") + it 'uploads a file', cassette: 'upload/success' do + file = @client.upload("#{path_prefix}/file.txt", 'Hello Dropbox!') expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("file.txt") + expect(file.name).to eq('file.txt') end - it "works with an IO object", :cassette => "upload/success_io" do - content = File.open(File.join(DropboxScaffoldBuilder.fixtures_path, "file.txt")) + it 'works with an IO object', cassette: 'upload/success_io' do + content = File.open(File.join(DropboxScaffoldBuilder.fixtures_path, 'file.txt')) file = @client.upload("#{path_prefix}/file_io.txt", content) expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("file_io.txt") - expect(file.content_hash).to eq("709a5cf259366d6ca6b2fa4d3b53c02f5ce2b2764e9d580711e3ffd24d79f5e9") + expect(file.name).to eq('file_io.txt') + expect(file.content_hash).to eq('709a5cf259366d6ca6b2fa4d3b53c02f5ce2b2764e9d580711e3ffd24d79f5e9') end - it "uploads a file with `add` write mode", :cassette => "upload/success_add" do - file = @client.upload("#{path_prefix}/file.txt", "Hola Dropbox!", { - :autorename => true, - :mode => :add + it 'uploads a file with `add` write mode', cassette: 'upload/success_add' do + file = @client.upload("#{path_prefix}/file.txt", 'Hola Dropbox!', { + autorename: true, + mode: :add }) expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("file (1).txt") + expect(file.name).to eq('file (1).txt') end - it "uploads a file with `overwrite` write mode", :cassette => "upload/success_overwrite" do - file = @client.upload("#{path_prefix}/file.txt", "Hola Dropbox!", { - :autorename => true, - :mode => :overwrite + it 'uploads a file with `overwrite` write mode', cassette: 'upload/success_overwrite' do + file = @client.upload("#{path_prefix}/file.txt", 'Hola Dropbox!', { + autorename: true, + mode: :overwrite }) expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("file.txt") + expect(file.name).to eq('file.txt') end - it "uploads a file with `update` write mode", :cassette => "upload/success_update" do + it 'uploads a file with `update` write mode', cassette: 'upload/success_update' do rev = @client.get_metadata("#{path_prefix}/file.txt").rev - file = @client.upload("#{path_prefix}/file.txt", "Hallo Dropbox!", { - :autorename => true, - :mode => DropboxApi::Metadata::WriteMode.new(:update, rev) + file = @client.upload("#{path_prefix}/file.txt", 'Hallo Dropbox!', { + autorename: true, + mode: DropboxApi::Metadata::WriteMode.new(:update, rev) }) expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("file.txt") + expect(file.name).to eq('file.txt') end - it "uploads a file with `overwrite` write mode", :cassette => "upload/success_client_modified" do + it 'uploads a file with `overwrite` write mode', cassette: 'upload/success_client_modified' do modified_at = Time.utc 2016, 12, 25, 12, 0 - file = @client.upload("#{path_prefix}/another_file.txt", "Our country is a mess!", { - :client_modified => modified_at + file = @client.upload("#{path_prefix}/another_file.txt", 'Our country is a mess!', { + client_modified: modified_at }) expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("another_file.txt") + expect(file.name).to eq('another_file.txt') expect(file.client_modified).to eq(modified_at) end - context "when too many write operations" do - it "raises a DropboxApi::Errors::TooManyWriteOperations exception", :cassette => "upload/too_many_write_operations" do + context 'when too many write operations' do + it 'raises a DropboxApi::Errors::TooManyWriteOperations exception', cassette: 'upload/too_many_write_operations' do errors = [] 15.times.map do |n| Thread.new do begin - @client.upload("#{path_prefix}/file_#{n}.txt", "Hello Dropbox!") + @client.upload("#{path_prefix}/file_#{n}.txt", 'Hello Dropbox!') rescue DropboxApi::Errors::TooManyWriteOperationsError => e errors << e end @@ -80,13 +81,13 @@ expect(errors.any?).to be_truthy end - it "raises an exception with info to retry", :cassette => "upload/too_many_write_operations" do + it 'raises an exception with info to retry', cassette: 'upload/too_many_write_operations' do errors = [] 15.times.map do |n| Thread.new do begin - @client.upload("#{path_prefix}/file_#{n}.txt", "Hello Dropbox!") + @client.upload("#{path_prefix}/file_#{n}.txt", 'Hello Dropbox!') rescue DropboxApi::Errors::TooManyWriteOperationsError => e errors << e end diff --git a/spec/endpoints/sharing/add_file_member_spec.rb b/spec/endpoints/sharing/add_file_member_spec.rb index 23bc7620..8471b971 100644 --- a/spec/endpoints/sharing/add_file_member_spec.rb +++ b/spec/endpoints/sharing/add_file_member_spec.rb @@ -1,11 +1,12 @@ -describe DropboxApi::Client, "#add_file_member" do +# frozen_string_literal: true +describe DropboxApi::Client, '#add_file_member' do before :each do @client = DropboxApi::Client.new end - it "adds 1 member to a file", :cassette => "add_file_member/success_1" do - file = "/bsd.pdf" - members = @client.add_file_member(file, "a@test.com") + it 'adds 1 member to a file', cassette: 'add_file_member/success_1' do + file = '/bsd.pdf' + members = @client.add_file_member(file, 'a@test.com') expect(members) .to be_a(DropboxApi::Results::AddFileMemberResultList) @@ -15,8 +16,8 @@ .to eq(:viewer) end - it "adds 2 members to a file", :cassette => "add_file_member/success_2" do - file = "/bsd.pdf" + it 'adds 2 members to a file', cassette: 'add_file_member/success_2' do + file = '/bsd.pdf' members = @client.add_file_member(file, %w(a@test.com b@test.com)) expect(members) @@ -27,24 +28,24 @@ .to eq([:viewer]) end - it "adds a member with comment", :cassette => "add_file_member/success_comment" do - file = "/bsd.pdf" + it 'adds a member with comment', cassette: 'add_file_member/success_comment' do + file = '/bsd.pdf' members = @client.add_file_member file, - "a@test.com", - :custom_message => "See my file down here." + 'a@test.com', + custom_message: 'See my file down here.' expect(members) .to be_a(DropboxApi::Results::AddFileMemberResultList) end - it "adds a member with access level", :cassette => "add_file_member/error_no_permission" do - file = "/bsd.pdf" + it 'adds a member with access level', cassette: 'add_file_member/error_no_permission' do + file = '/bsd.pdf' # Using :viewer_no_comment as access level will fail with no_permission. expect { @client.add_file_member file, - "a@test.com", - :access_level => :viewer_no_comment + 'a@test.com', + access_level: :viewer_no_comment }.to raise_error(DropboxApi::Errors::NoPermissionError) end end diff --git a/spec/endpoints/sharing/add_folder_member_spec.rb b/spec/endpoints/sharing/add_folder_member_spec.rb index 87ebc6ca..84f2bdd6 100644 --- a/spec/endpoints/sharing/add_folder_member_spec.rb +++ b/spec/endpoints/sharing/add_folder_member_spec.rb @@ -1,40 +1,41 @@ -describe DropboxApi::Client, "#add_folder_member" do +# frozen_string_literal: true +describe DropboxApi::Client, '#add_folder_member' do before :each do @client = DropboxApi::Client.new end - it "shares the folder", :cassette => "add_folder_member/success" do - folder_id = "1236358158" - folder = @client.add_folder_member folder_id, "somebody@test.com" + it 'shares the folder', cassette: 'add_folder_member/success' do + folder_id = '1236358158' + folder = @client.add_folder_member folder_id, 'somebody@test.com' # The endpoint doesn't have any return values, can't test the output! end - it "shares the folder, if the folder id is a number", :cassette => "add_folder_member/success_numeric" do + it 'shares the folder, if the folder id is a number', cassette: 'add_folder_member/success_numeric' do folder_id = 1236358158 - folder = @client.add_folder_member folder_id, "somebody@test.com" + folder = @client.add_folder_member folder_id, 'somebody@test.com' # The endpoint doesn't have any return values, can't test the output! end - it "shares the folder, if the param is an AddMember object", :cassette => "add_folder_member/success" do + it 'shares the folder, if the param is an AddMember object', cassette: 'add_folder_member/success' do folder_id = 1236358158 - folder = @client.add_folder_member folder_id, "somebody@test.com" + folder = @client.add_folder_member folder_id, 'somebody@test.com' # The endpoint doesn't have any return values, can't test the output! end - it "shares the folder, if the member param is an email string", :cassette => "add_folder_member/success" do + it 'shares the folder, if the member param is an email string', cassette: 'add_folder_member/success' do folder_id = 1236358158 - folder = @client.add_folder_member folder_id, "somebody@test.com" + folder = @client.add_folder_member folder_id, 'somebody@test.com' # The endpoint doesn't have any return values, can't test the output! end - it "fails with an invalid folder id", :cassette => "add_folder_member/invalid_folder" do - folder_id = "xxx" + it 'fails with an invalid folder id', cassette: 'add_folder_member/invalid_folder' do + folder_id = 'xxx' expect { - folder = @client.add_folder_member folder_id, "somebody@test.com" + folder = @client.add_folder_member folder_id, 'somebody@test.com' }.to raise_error(DropboxApi::Errors::InvalidIdError) end diff --git a/spec/endpoints/sharing/create_shared_link_with_settings_spec.rb b/spec/endpoints/sharing/create_shared_link_with_settings_spec.rb index 35b2ad00..c91abb60 100644 --- a/spec/endpoints/sharing/create_shared_link_with_settings_spec.rb +++ b/spec/endpoints/sharing/create_shared_link_with_settings_spec.rb @@ -1,50 +1,51 @@ -describe DropboxApi::Client, "#create_shared_link_with_settings" do +# frozen_string_literal: true +describe DropboxApi::Client, '#create_shared_link_with_settings' do before :each do @client = DropboxApi::Client.new end - context "on a file" do - it "creates a shared link for basic and pro users", :cassette => "create_shared_link_with_settings/success_file" do - link = @client.create_shared_link_with_settings "/file_for_sharing.docx" + context 'on a file' do + it 'creates a shared link for basic and pro users', cassette: 'create_shared_link_with_settings/success_file' do + link = @client.create_shared_link_with_settings '/file_for_sharing.docx' expect(link).to be_a(DropboxApi::Metadata::FileLinkMetadata) end - it "creates a shared link with settings for pro users", :cassette => "create_shared_link_with_settings/success_file_with_settings" do - link = @client.create_shared_link_with_settings("/file_for_sharing.docx", { :expires => "2019-03-12T10:34:42Z" }) + it 'creates a shared link with settings for pro users', cassette: 'create_shared_link_with_settings/success_file_with_settings' do + link = @client.create_shared_link_with_settings('/file_for_sharing.docx', { expires: '2019-03-12T10:34:42Z' }) expect(link).to be_a(DropboxApi::Metadata::FileLinkMetadata) end - it "raises an error if settings options are passed for basic users", :cassette => "create_shared_link_with_settings/error_no_permission_for_file" do + it 'raises an error if settings options are passed for basic users', cassette: 'create_shared_link_with_settings/error_no_permission_for_file' do expect { - @client.create_shared_link_with_settings("/file_for_sharing.docx", { :expires => "2019-03-12T10:34:42Z" }) + @client.create_shared_link_with_settings('/file_for_sharing.docx', { expires: '2019-03-12T10:34:42Z' }) }.to raise_error(DropboxApi::Errors::NoPermissionError) end - it "raises an error if already shared for basic and pro users", :cassette => "create_shared_link_with_settings/already_shared" do + it 'raises an error if already shared for basic and pro users', cassette: 'create_shared_link_with_settings/already_shared' do expect { - @client.create_shared_link_with_settings "/file_for_sharing.docx" + @client.create_shared_link_with_settings '/file_for_sharing.docx' }.to raise_error(DropboxApi::Errors::SharedLinkAlreadyExistsError) end end - context "on a folder" do - it "creates a shared link for basic and pro users", :cassette => "create_shared_link_with_settings/success_folder" do - link = @client.create_shared_link_with_settings "/folder_for_sharing" + context 'on a folder' do + it 'creates a shared link for basic and pro users', cassette: 'create_shared_link_with_settings/success_folder' do + link = @client.create_shared_link_with_settings '/folder_for_sharing' expect(link).to be_a(DropboxApi::Metadata::FolderLinkMetadata) end - it "creates a shared link with settings for pro users", :cassette => "create_shared_link_with_settings/success_folder_with_settings" do - link = @client.create_shared_link_with_settings("/folder_for_sharing", { :expires => "2019-03-12T10:34:42Z" }) + it 'creates a shared link with settings for pro users', cassette: 'create_shared_link_with_settings/success_folder_with_settings' do + link = @client.create_shared_link_with_settings('/folder_for_sharing', { expires: '2019-03-12T10:34:42Z' }) expect(link).to be_a(DropboxApi::Metadata::FolderLinkMetadata) end - it "raises an error if settings options are passed for basic user", :cassette => "create_shared_link_with_settings/error_no_permission_for_folder" do + it 'raises an error if settings options are passed for basic user', cassette: 'create_shared_link_with_settings/error_no_permission_for_folder' do expect { - @client.create_shared_link_with_settings("/folder_for_sharing", { :expires => "2019-03-12T10:34:42Z" }) + @client.create_shared_link_with_settings('/folder_for_sharing', { expires: '2019-03-12T10:34:42Z' }) }.to raise_error(DropboxApi::Errors::NoPermissionError) end end diff --git a/spec/endpoints/sharing/get_shared_link_metadata_spec.rb b/spec/endpoints/sharing/get_shared_link_metadata_spec.rb index cdd51f44..8a6ca9d4 100644 --- a/spec/endpoints/sharing/get_shared_link_metadata_spec.rb +++ b/spec/endpoints/sharing/get_shared_link_metadata_spec.rb @@ -1,4 +1,5 @@ -describe DropboxApi::Client, "#get_shared_link_metadata" do +# frozen_string_literal: true +describe DropboxApi::Client, '#get_shared_link_metadata' do let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :get_shared_link_metadata } @@ -7,9 +8,9 @@ @client = DropboxApi::Client.new end - it "works with a file", :cassette => "get_shared_link_metadata/success_file" do + it 'works with a file', cassette: 'get_shared_link_metadata/success_file' do shared_link = @client - .list_shared_links(:path => "#{path_prefix}/shared_file.txt") + .list_shared_links(path: "#{path_prefix}/shared_file.txt") .links .first result = @client.get_shared_link_metadata shared_link.url @@ -17,9 +18,9 @@ expect(result).to be_a(DropboxApi::Metadata::FileLinkMetadata) end - it "works with a folder", :cassette => "get_shared_link_metadata/success_folder" do + it 'works with a folder', cassette: 'get_shared_link_metadata/success_folder' do shared_link = @client - .list_shared_links(:path => "#{path_prefix}/shared_folder") + .list_shared_links(path: "#{path_prefix}/shared_folder") .links .first result = @client.get_shared_link_metadata shared_link.url @@ -27,8 +28,8 @@ expect(result).to be_a(DropboxApi::Metadata::FolderLinkMetadata) end - it "raises an error if the link can't be found", :cassette => "get_shared_link_metadata/error_not_found" do - bad_link = "https://www.dropbox.com/sh/abcd/1234?dl=0" + it "raises an error if the link can't be found", cassette: 'get_shared_link_metadata/error_not_found' do + bad_link = 'https://www.dropbox.com/sh/abcd/1234?dl=0' expect { @client.get_shared_link_metadata bad_link diff --git a/spec/endpoints/sharing/list_file_members_spec.rb b/spec/endpoints/sharing/list_file_members_spec.rb index 4dffa156..c1592396 100644 --- a/spec/endpoints/sharing/list_file_members_spec.rb +++ b/spec/endpoints/sharing/list_file_members_spec.rb @@ -1,16 +1,17 @@ -describe DropboxApi::Client, "#list_file_members" do +# frozen_string_literal: true +describe DropboxApi::Client, '#list_file_members' do before :each do @client = DropboxApi::Client.new end - it "lists file members", :cassette => "list_file_members/success" do - result = @client.list_file_members "1231273663" + it 'lists file members', cassette: 'list_file_members/success' do + result = @client.list_file_members '1231273663' expect(result).to be_a(DropboxApi::Results::SharedFileMembers) end - it "lists file members including member actions", :cassette => "list_file_members/success_with_actions" do - result = @client.list_file_members "1231273663", [:remove, :make_owner] + it 'lists file members including member actions', cassette: 'list_file_members/success_with_actions' do + result = @client.list_file_members '1231273663', [:remove, :make_owner] expect(result).to be_a(DropboxApi::Results::SharedFileMembers) end diff --git a/spec/endpoints/sharing/list_folder_members_spec.rb b/spec/endpoints/sharing/list_folder_members_spec.rb index a9ed2d50..b5b6e47e 100644 --- a/spec/endpoints/sharing/list_folder_members_spec.rb +++ b/spec/endpoints/sharing/list_folder_members_spec.rb @@ -1,16 +1,17 @@ -describe DropboxApi::Client, "#list_folder_members" do +# frozen_string_literal: true +describe DropboxApi::Client, '#list_folder_members' do before :each do @client = DropboxApi::Client.new end - it "lists folder members", :cassette => "list_folder_members/success" do - result = @client.list_folder_members "1231273663" + it 'lists folder members', cassette: 'list_folder_members/success' do + result = @client.list_folder_members '1231273663' expect(result).to be_a(DropboxApi::Results::SharedFolderMembers) end - it "lists folder members including member actions", :cassette => "list_folder_members/success_with_actions" do - result = @client.list_folder_members "1231273663", [:remove, :make_owner] + it 'lists folder members including member actions', cassette: 'list_folder_members/success_with_actions' do + result = @client.list_folder_members '1231273663', [:remove, :make_owner] expect(result).to be_a(DropboxApi::Results::SharedFolderMembers) end diff --git a/spec/endpoints/sharing/list_shared_links_spec.rb b/spec/endpoints/sharing/list_shared_links_spec.rb index 07c1b34e..89543426 100644 --- a/spec/endpoints/sharing/list_shared_links_spec.rb +++ b/spec/endpoints/sharing/list_shared_links_spec.rb @@ -1,17 +1,18 @@ -describe DropboxApi::Client, "#list_shared_links" do +# frozen_string_literal: true +describe DropboxApi::Client, '#list_shared_links' do before :each do @client = DropboxApi::Client.new end - context "on a file" do - it "returns a file link", :cassette => "list_shared_links/success_file" do - result = @client.list_shared_links :path => "/some_folder/file.txt" + context 'on a file' do + it 'returns a file link', cassette: 'list_shared_links/success_file' do + result = @client.list_shared_links path: '/some_folder/file.txt' expect(result.links.last).to be_a(DropboxApi::Metadata::FileLinkMetadata) end - it "lists all shared links", :cassette => "list_shared_links/success_file" do - links = @client.list_shared_links(:path => "/some_folder/file.txt").links + it 'lists all shared links', cassette: 'list_shared_links/success_file' do + links = @client.list_shared_links(path: '/some_folder/file.txt').links expect(links.map &:url).to match_array(%w( https://www.dropbox.com/sh/5b0bmldpa1qi772/AAAwKkKiTdb1A78bzHCKQLeHa?dl=0 @@ -19,10 +20,10 @@ )) end - it "gets the direct shared link", :cassette => "list_shared_links/success_file_direct_only" do + it 'gets the direct shared link', cassette: 'list_shared_links/success_file_direct_only' do links = @client.list_shared_links({ - :path => "/some_folder/file.txt", - :direct_only => true + path: '/some_folder/file.txt', + direct_only: true }).links expect(links.map &:url).to match_array(%w( @@ -31,15 +32,15 @@ end end - context "on a folder" do - it "returns a folder link", :cassette => "list_shared_links/success_folder" do - result = @client.list_shared_links :path => "/some_folder/another_folder" + context 'on a folder' do + it 'returns a folder link', cassette: 'list_shared_links/success_folder' do + result = @client.list_shared_links path: '/some_folder/another_folder' expect(result.links.last).to be_a(DropboxApi::Metadata::FolderLinkMetadata) end - it "lists all shared links", :cassette => "list_shared_links/success_folder" do - links = @client.list_shared_links(:path => "/some_folder/another_folder").links + it 'lists all shared links', cassette: 'list_shared_links/success_folder' do + links = @client.list_shared_links(path: '/some_folder/another_folder').links expect(links.map &:url).to match_array(%w( https://www.dropbox.com/sh/5b0bmldpa1qi772/AAAwKkKiTdb1A78bzHCKQLeHa?dl=0 diff --git a/spec/endpoints/sharing/revoke_shared_link_spec.rb b/spec/endpoints/sharing/revoke_shared_link_spec.rb index c0ab6222..93df13fb 100644 --- a/spec/endpoints/sharing/revoke_shared_link_spec.rb +++ b/spec/endpoints/sharing/revoke_shared_link_spec.rb @@ -1,30 +1,31 @@ -describe DropboxApi::Client, "#revoke_shared_link" do +# frozen_string_literal: true +describe DropboxApi::Client, '#revoke_shared_link' do before :each do @client = DropboxApi::Client.new end - context "revoke shared link access" do - it "revoke a shared link", :cassette => "revoke_shared_link/success" do - link = @client.revoke_shared_link "https://www.dropbox.com/sh/t0ebpiojwy4l1bn/AAAcU6qf20b8R-SG5_PJCBOQa?dl=0" + context 'revoke shared link access' do + it 'revoke a shared link', cassette: 'revoke_shared_link/success' do + link = @client.revoke_shared_link 'https://www.dropbox.com/sh/t0ebpiojwy4l1bn/AAAcU6qf20b8R-SG5_PJCBOQa?dl=0' # The endpoint doesn't have any return values, can't test the output! end - it "raises an error if link is not found", :cassette => "revoke_shared_link/not_found" do + it 'raises an error if link is not found', cassette: 'revoke_shared_link/not_found' do expect { - @client.revoke_shared_link "https://www.dropbox.com/sh/t0ebpiojwy4l1bn/AAAcU6qf20b8R-SG5_PJCBOQa?dl=0" + @client.revoke_shared_link 'https://www.dropbox.com/sh/t0ebpiojwy4l1bn/AAAcU6qf20b8R-SG5_PJCBOQa?dl=0' }.to raise_error(DropboxApi::Errors::SharedLinkNotFoundError) end - it "raises access denied error if not permitted", :cassette => "revoke_shared_link/access_denied" do + it 'raises access denied error if not permitted', cassette: 'revoke_shared_link/access_denied' do expect { - @client.revoke_shared_link "https://www.dropbox.com/s/al0w4e11j0e1kp3/file_for_sharing.docx?dl=0" + @client.revoke_shared_link 'https://www.dropbox.com/s/al0w4e11j0e1kp3/file_for_sharing.docx?dl=0' }.to raise_error(DropboxApi::Errors::SharedLinkAccessDeniedError) end - it "raises shared link malformed error if link is malformed", :cassette => "revoke_shared_link/malformed_shared_link" do + it 'raises shared link malformed error if link is malformed', cassette: 'revoke_shared_link/malformed_shared_link' do expect { - @client.revoke_shared_link "https://www.dropbox.com/al0w4e11j0e1kp3/file_for_sharing.docx?dl=0" + @client.revoke_shared_link 'https://www.dropbox.com/al0w4e11j0e1kp3/file_for_sharing.docx?dl=0' }.to raise_error(DropboxApi::Errors::SharedLinkMalformedError) end end diff --git a/spec/endpoints/sharing/share_folder_spec.rb b/spec/endpoints/sharing/share_folder_spec.rb index 3fb3e1ef..e4c5652c 100644 --- a/spec/endpoints/sharing/share_folder_spec.rb +++ b/spec/endpoints/sharing/share_folder_spec.rb @@ -1,24 +1,25 @@ -describe DropboxApi::Client, "#share_folder" do +# frozen_string_literal: true +describe DropboxApi::Client, '#share_folder' do before :each do @client = DropboxApi::Client.new end - it "returns the shared folder", :cassette => "share_folder/success" do - folder = @client.share_folder("/folder_k") + it 'returns the shared folder', cassette: 'share_folder/success' do + folder = @client.share_folder('/folder_k') expect(folder).to be_a(DropboxApi::Metadata::SharedFolder) end - it "returns the shared folder, even if already shared", :cassette => "share_folder/bad_path" do - folder = @client.share_folder("/already_shared") + it 'returns the shared folder, even if already shared', cassette: 'share_folder/bad_path' do + folder = @client.share_folder('/already_shared') expect(folder).to be_a(DropboxApi::Metadata::SharedFolder) end - it "contains a shared folder id", :cassette => "share_folder/success" do - folder = @client.share_folder("/folder_k") + it 'contains a shared folder id', cassette: 'share_folder/success' do + folder = @client.share_folder('/folder_k') expect(folder.shared_folder_id.to_s) - .to eq("1236414195") # taken from fixture (share_folder/success.yml) + .to eq('1236414195') # taken from fixture (share_folder/success.yml) end end diff --git a/spec/endpoints/sharing/unshare_file_spec.rb b/spec/endpoints/sharing/unshare_file_spec.rb index 9eb57f0e..fa7c100c 100644 --- a/spec/endpoints/sharing/unshare_file_spec.rb +++ b/spec/endpoints/sharing/unshare_file_spec.rb @@ -1,23 +1,24 @@ -describe DropboxApi::Client, "#unshare_file" do +# frozen_string_literal: true +describe DropboxApi::Client, '#unshare_file' do before :each do @client = DropboxApi::Client.new end - it "unshares the file", :cassette => "unshare_file/success" do - file = @client.unshare_file("id:xyz123") + it 'unshares the file', cassette: 'unshare_file/success' do + file = @client.unshare_file('id:xyz123') # The endpoint doesn't have any return values, can't test the output! end - it "returns file access permission error", :cassette => "unshare_file/error_no_permission" do + it 'returns file access permission error', cassette: 'unshare_file/error_no_permission' do expect { - @client.unshare_file("id:xyz123") + @client.unshare_file('id:xyz123') }.to raise_error(DropboxApi::Errors::NoPermissionError) end - it "returns email unverified error", :cassette => "unshare_file/error_email_unverified" do + it 'returns email unverified error', cassette: 'unshare_file/error_email_unverified' do expect { - @client.unshare_file("id:xyz123") + @client.unshare_file('id:xyz123') }.to raise_error(DropboxApi::Errors::EmailUnverifiedError) end end diff --git a/spec/endpoints/users/get_account_batch_spec.rb b/spec/endpoints/users/get_account_batch_spec.rb index a23dba07..5c51236c 100644 --- a/spec/endpoints/users/get_account_batch_spec.rb +++ b/spec/endpoints/users/get_account_batch_spec.rb @@ -1,12 +1,13 @@ -describe DropboxApi::Client, "#get_account_batch" do +# frozen_string_literal: true +describe DropboxApi::Client, '#get_account_batch' do before :each do @client = DropboxApi::Client.new end - it "returns account information of all given IDs", :cassette => "get_account_batch/success" do + it 'returns account information of all given IDs', cassette: 'get_account_batch/success' do test_accounts = { - "dbid:AACiYqkuK0t_wIvlr9BduHKdhzk_H28Dg0U" => "Antonio Hidalgo", - "dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs" => "Jesus Burgos" + 'dbid:AACiYqkuK0t_wIvlr9BduHKdhzk_H28Dg0U' => 'Antonio Hidalgo', + 'dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs' => 'Jesus Burgos' } accounts = @client.get_account_batch test_accounts.keys @@ -17,7 +18,7 @@ end end - it "raises an error if one account can't e found", :cassette => "get_account_batch/no_account" do + it 'raises an error if one account cannot be found', cassette: 'get_account_batch/no_account' do account_ids = %w( dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs diff --git a/spec/endpoints/users/get_account_spec.rb b/spec/endpoints/users/get_account_spec.rb index eae2e460..45fbe36f 100644 --- a/spec/endpoints/users/get_account_spec.rb +++ b/spec/endpoints/users/get_account_spec.rb @@ -1,17 +1,18 @@ -describe DropboxApi::Client, "#get_account" do +# frozen_string_literal: true +describe DropboxApi::Client, '#get_account' do before :each do @client = DropboxApi::Client.new end - it "returns the account information", :cassette => "get_account/success" do - account = @client.get_account "dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs" + it 'returns the account information', cassette: 'get_account/success' do + account = @client.get_account 'dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs' expect(account).to be_a(DropboxApi::Metadata::BasicAccount) end - it "raises an error if the account can't be found", :cassette => "get_account/no_account" do + it "raises an error if the account can't be found", cassette: 'get_account/no_account' do expect { - @client.get_account "dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX" + @client.get_account 'dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX' }.to raise_error(DropboxApi::Errors::NoAccountError) end end diff --git a/spec/endpoints/users/get_current_account_spec.rb b/spec/endpoints/users/get_current_account_spec.rb index dcc011ee..dc155ed3 100644 --- a/spec/endpoints/users/get_current_account_spec.rb +++ b/spec/endpoints/users/get_current_account_spec.rb @@ -1,11 +1,13 @@ -describe DropboxApi::Client, "#get_current_account" do +# frozen_string_literal: true +describe DropboxApi::Client, '#get_current_account' do before :each do @client = DropboxApi::Client.new end - it "returns the current account information", :cassette => "get_current_account/success" do + it 'returns the current account information', cassette: 'get_current_account/success' do account = @client.get_current_account expect(account).to be_a(DropboxApi::Metadata::BasicAccount) + expect(account.root_info).to be_a(DropboxApi::Metadata::UserRootInfo) end end diff --git a/spec/endpoints/users/get_space_usage_spec.rb b/spec/endpoints/users/get_space_usage_spec.rb index 18fc6951..a06c77a8 100644 --- a/spec/endpoints/users/get_space_usage_spec.rb +++ b/spec/endpoints/users/get_space_usage_spec.rb @@ -1,9 +1,10 @@ -describe DropboxApi::Client, "#get_current_account" do +# frozen_string_literal: true +describe DropboxApi::Client, '#get_current_account' do before :each do @client = DropboxApi::Client.new end - it "returns the account usage information", :cassette => "get_space_usage/success" do + it 'returns the account usage information', cassette: 'get_space_usage/success' do space_usage = @client.get_space_usage expect(space_usage).to be_a(DropboxApi::Metadata::SpaceUsage) diff --git a/spec/endpoints/virtual/upload_by_chunks_spec.rb b/spec/endpoints/virtual/upload_by_chunks_spec.rb new file mode 100644 index 00000000..ae8824f0 --- /dev/null +++ b/spec/endpoints/virtual/upload_by_chunks_spec.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true +describe DropboxApi::Client, '#upload' do + let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :upload_by_chunks } + before :each do + @client = DropboxApi::Client.new + end + + it 'uploads a file', cassette: 'upload_by_chunks/success' do + file = @client.upload_by_chunks("#{path_prefix}/file.txt", 'Hello Dropbox!') + + expect(file).to be_a(DropboxApi::Metadata::File) + expect(file.name).to eq('file.txt') + end + + it 'works with an IO object', cassette: 'upload_by_chunks/success_io' do + content = File.open(File.join(DropboxScaffoldBuilder.fixtures_path, 'file.txt')) + file = @client.upload_by_chunks("#{path_prefix}/file_io.txt", content) + + expect(file).to be_a(DropboxApi::Metadata::File) + expect(file.name).to eq('file_io.txt') + expect(file.content_hash).to eq('709a5cf259366d6ca6b2fa4d3b53c02f5ce2b2764e9d580711e3ffd24d79f5e9') + end + + it 'uploads a file with `add` write mode', cassette: 'upload_by_chunks/success_add' do + file = @client.upload_by_chunks("#{path_prefix}/file.txt", 'Hola Dropbox!', { + autorename: true, + mode: :add + }) + + expect(file).to be_a(DropboxApi::Metadata::File) + expect(file.name).to eq('file (1).txt') + end +end diff --git a/spec/endpoints/virutal/upload_by_chunks_spec.rb b/spec/endpoints/virutal/upload_by_chunks_spec.rb deleted file mode 100644 index db6068c9..00000000 --- a/spec/endpoints/virutal/upload_by_chunks_spec.rb +++ /dev/null @@ -1,32 +0,0 @@ -describe DropboxApi::Client, "#upload" do - let(:path_prefix) { DropboxScaffoldBuilder.prefix_for :upload_by_chunks } - before :each do - @client = DropboxApi::Client.new - end - - it "uploads a file", :cassette => "upload_by_chunks/success" do - file = @client.upload_by_chunks("#{path_prefix}/file.txt", "Hello Dropbox!") - - expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("file.txt") - end - - it "works with an IO object", :cassette => "upload_by_chunks/success_io" do - content = File.open(File.join(DropboxScaffoldBuilder.fixtures_path, "file.txt")) - file = @client.upload_by_chunks("#{path_prefix}/file_io.txt", content) - - expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("file_io.txt") - expect(file.content_hash).to eq("709a5cf259366d6ca6b2fa4d3b53c02f5ce2b2764e9d580711e3ffd24d79f5e9") - end - - it "uploads a file with `add` write mode", :cassette => "upload_by_chunks/success_add" do - file = @client.upload_by_chunks("#{path_prefix}/file.txt", "Hola Dropbox!", { - :autorename => true, - :mode => :add - }) - - expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("file (1).txt") - end -end diff --git a/spec/fixtures/vcr_cassettes/authenticator/success_with_refresh_token.yml b/spec/fixtures/vcr_cassettes/authenticator/success_with_refresh_token.yml new file mode 100644 index 00000000..c9c5db53 --- /dev/null +++ b/spec/fixtures/vcr_cassettes/authenticator/success_with_refresh_token.yml @@ -0,0 +1,56 @@ +--- +http_interactions: +- request: + method: post + uri: https://api.dropboxapi.com/oauth2/token + body: + encoding: UTF-8 + string: client_id=CLIENT_ID&client_secret=CLIENT_SECRET&code=ACCESS_CODEpLfs_y4vgnb3M&grant_type=authorization_code + headers: + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/x-www-form-urlencoded + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + X-Server-Response-Time: + - '398' + Content-Type: + - text/javascript + Accept-Encoding: + - identity,gzip + Date: + - Wed, 29 Sep 2021 16:45:28 GMT + Server: + - envoy + Vary: + - Accept-Encoding + X-Dropbox-Response-Origin: + - far_remote + X-Dropbox-Request-Id: + - 8850e1c797e1405193d537535adbf514 + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"uid": "44076342", "access_token": "MOCK_ACCESS_TOKEN", + "expires_in": 14399, "token_type": "bearer", "scope": "account_info.read account_info.write + contacts.read contacts.write file_requests.read file_requests.write files.content.read + files.content.write files.metadata.read files.metadata.write sharing.read + sharing.write", "refresh_token": "MOCK_REFRESH_TOKEN", + "account_id": "dbid:AABOLtA1rT6rRK4vajKZrWqLZ7wVnV863u4"}' + recorded_at: Wed, 29 Sep 2021 16:45:29 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/authenticator/success_with_short_lived_token.yml b/spec/fixtures/vcr_cassettes/authenticator/success_with_short_lived_token.yml new file mode 100644 index 00000000..24797cc9 --- /dev/null +++ b/spec/fixtures/vcr_cassettes/authenticator/success_with_short_lived_token.yml @@ -0,0 +1,55 @@ +--- +http_interactions: +- request: + method: post + uri: https://api.dropboxapi.com/oauth2/token + body: + encoding: UTF-8 + string: client_id=CLIENT_ID&client_secret=CLIENT_SECRET&code=ACCESS_CODEhVAVTMlCvO0Qs&grant_type=authorization_code + headers: + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/x-www-form-urlencoded + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + X-Server-Response-Time: + - '430' + Content-Type: + - text/javascript + Accept-Encoding: + - identity,gzip + Date: + - Fri, 24 Sep 2021 15:12:40 GMT + Server: + - envoy + Vary: + - Accept-Encoding + X-Dropbox-Response-Origin: + - far_remote + X-Dropbox-Request-Id: + - 804f1fde0c254704962084a20379807d + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"uid": "44076342", "access_token": "MOCK_ACCESS_TOKEN", + "expires_in": 14400, "token_type": "bearer", "scope": "account_info.read account_info.write + contacts.read contacts.write file_requests.read file_requests.write files.content.read + files.content.write files.metadata.read files.metadata.write sharing.read + sharing.write", "account_id": "dbid:AABOLtA1rT6rRK4vajKZrWqLZ7wVnV863u4"}' + recorded_at: Fri, 24 Sep 2021 15:12:41 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/client/raise_on_401.yml b/spec/fixtures/vcr_cassettes/client/raise_on_401.yml new file mode 100644 index 00000000..817efd4d --- /dev/null +++ b/spec/fixtures/vcr_cassettes/client/raise_on_401.yml @@ -0,0 +1,51 @@ +--- +http_interactions: +- request: + method: post + uri: https://api.dropboxapi.com/2/files/list_folder + body: + encoding: UTF-8 + string: '{"recursive":false,"include_media_info":false,"include_deleted":false,"path":""}' + headers: + Authorization: + - Bearer MOCK_EXPIRED_AUTHORIZATION_BEARER + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/json + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 401 + message: Unauthorized + headers: + Cache-Control: + - no-cache + Content-Security-Policy: + - sandbox allow-forms allow-scripts + Www-Authenticate: + - Bearer realm="Dropbox-API" + X-Content-Type-Options: + - nosniff + Content-Type: + - application/json + Accept-Encoding: + - identity,gzip + Date: + - Wed, 29 Sep 2021 17:44:28 GMT + Server: + - envoy + Content-Length: + - '85' + X-Dropbox-Response-Origin: + - far_remote + X-Dropbox-Request-Id: + - 97c6c02235b4468d9022c41e6a08b7d3 + body: + encoding: UTF-8 + string: '{"error_summary": "expired_access_token/", "error": {".tag": "expired_access_token"}}' + recorded_at: Wed, 29 Sep 2021 17:44:29 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/client/refresh_token_if_expired.yml b/spec/fixtures/vcr_cassettes/client/refresh_token_if_expired.yml new file mode 100644 index 00000000..259af123 --- /dev/null +++ b/spec/fixtures/vcr_cassettes/client/refresh_token_if_expired.yml @@ -0,0 +1,127 @@ +--- +http_interactions: +- request: + method: post + uri: https://api.dropboxapi.com/oauth2/token + body: + encoding: UTF-8 + string: client_id=CLIENT_ID&client_secret=CLIENT_SECRET&grant_type=refresh_token&refresh_token=MOCK_REFRESH_TOKEN + headers: + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/x-www-form-urlencoded + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + X-Server-Response-Time: + - '37' + Content-Type: + - text/javascript + Accept-Encoding: + - identity,gzip + Date: + - Wed, 29 Sep 2021 16:27:40 GMT + Server: + - envoy + Vary: + - Accept-Encoding + X-Dropbox-Response-Origin: + - far_remote + X-Dropbox-Request-Id: + - 10e9bf0dd61e462ca092aff976abcd45 + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"token_type": "bearer", "access_token": "MOCK_ACCESS_TOKEN", + "expires_in": 14400}' + recorded_at: Wed, 29 Sep 2021 16:27:40 GMT +- request: + method: post + uri: https://api.dropboxapi.com/2/files/list_folder + body: + encoding: UTF-8 + string: '{"recursive":false,"include_media_info":false,"include_deleted":false,"path":""}' + headers: + Authorization: + - Bearer MOCK_ACCESS_TOKEN + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/json + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + X-Server-Response-Time: + - '124' + Content-Type: + - application/json + Accept-Encoding: + - identity,gzip + Date: + - Wed, 29 Sep 2021 16:27:41 GMT + Server: + - envoy + Vary: + - Accept-Encoding + X-Dropbox-Response-Origin: + - far_remote + X-Dropbox-Request-Id: + - d70c0ab18549441fa30c76b0fd63e703 + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"entries": [{".tag": "folder", "name": "PleaseLetMeTest''s shared + workspace", "path_lower": "/pleaseletmetest''s shared workspace", "path_display": + "/PleaseLetMeTest''s shared workspace", "id": "id:L5U1_AOVa-QAAAAAAAA3-g"}, + {".tag": "folder", "name": "dropbox_api_fixtures", "path_lower": "/dropbox_api_fixtures", + "path_display": "/dropbox_api_fixtures", "id": "id:L5U1_AOVa-QAAAAAAAA3-w"}, + {".tag": "folder", "name": "Create Batch", "path_lower": "/create batch", + "path_display": "/Create Batch", "id": "id:L5U1_AOVa-QAAAAAAAA4oQ"}, {".tag": + "folder", "name": "Create Batch 1", "path_lower": "/create batch 1", "path_display": + "/Create Batch 1", "id": "id:L5U1_AOVa-QAAAAAAAA4og"}, {".tag": "folder", + "name": "Create Batch 1 (1)", "path_lower": "/create batch 1 (1)", "path_display": + "/Create Batch 1 (1)", "id": "id:L5U1_AOVa-QAAAAAAAA4ow"}, {".tag": "folder", + "name": "arizona_baby", "path_lower": "/arizona_baby", "path_display": "/arizona_baby", + "id": "id:L5U1_AOVa-QAAAAAAAA4pA"}, {".tag": "folder", "name": "b.jpg", "path_lower": + "/b.jpg", "path_display": "/b.jpg", "id": "id:L5U1_AOVa-QAAAAAAAA4pQ"}, {".tag": + "folder", "name": "Homework", "path_lower": "/homework", "path_display": "/Homework", + "id": "id:L5U1_AOVa-QAAAAAAAA4qA"}, {".tag": "file", "name": "target.txt", + "path_lower": "/target.txt", "path_display": "/target.txt", "id": "id:L5U1_AOVa-QAAAAAAAA4pg", + "client_modified": "2021-02-07T01:09:05Z", "server_modified": "2021-02-07T01:09:05Z", + "rev": "5bab4b3222c52043720ae", "size": 22, "is_downloadable": true, "content_hash": + "2064faa877255c7097e19c8ce5daada411478d0bfb8ed57837eeaa53bd4a10b3"}, {".tag": + "file", "name": "file.zip", "path_lower": "/file.zip", "path_display": "/file.zip", + "id": "id:L5U1_AOVa-QAAAAAAAA4rQ", "client_modified": "2021-02-07T01:10:00Z", + "server_modified": "2021-02-07T01:11:10Z", "rev": "5bab4ba9864db043720ae", + "size": 1073741824, "is_downloadable": true, "content_hash": "0ade23b455a4127f8626e570875abdf248625c4df8246a9578e25f6d8bf0aed2"}], + "cursor": "AAFHnM-0aZjDkwZWbd6GjbSLfmk7p5AZ0KVn-JBta3HJtW4mne4nKWyweQkMa4b4mYw4yvvRRMq6aY4wjPNCTI60g0vxn89wTbM5GZtzpIvH05GhnVPlDtWjqMVf_sPis8eoogifXvIsxrELLdgq3zUQSCvG3raE4VuhU9i2BPlPkp3ewECVG170d0PYoey8Ao4", + "has_more": false}' + recorded_at: Wed, 29 Sep 2021 16:27:41 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/client/refresh_token_on_401.yml b/spec/fixtures/vcr_cassettes/client/refresh_token_on_401.yml new file mode 100644 index 00000000..eebaba62 --- /dev/null +++ b/spec/fixtures/vcr_cassettes/client/refresh_token_on_401.yml @@ -0,0 +1,175 @@ +--- +http_interactions: +- request: + method: post + uri: https://api.dropboxapi.com/2/files/list_folder + body: + encoding: UTF-8 + string: '{"recursive":false,"include_media_info":false,"include_deleted":false,"path":""}' + headers: + Authorization: + - Bearer MOCK_ACCESS_TOKEN + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/json + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 401 + message: Unauthorized + headers: + Cache-Control: + - no-cache + Content-Security-Policy: + - sandbox allow-forms allow-scripts + Www-Authenticate: + - Bearer realm="Dropbox-API" + X-Content-Type-Options: + - nosniff + Content-Type: + - application/json + Accept-Encoding: + - identity,gzip + Date: + - Wed, 29 Sep 2021 20:48:38 GMT + Server: + - envoy + Content-Length: + - '88' + X-Dropbox-Response-Origin: + - far_remote + X-Dropbox-Request-Id: + - 61d7208bfc8f4729ab932769bbffc2c8 + body: + encoding: UTF-8 + string: '{"error_summary": "expired_access_token/...", "error": {".tag": "expired_access_token"}}' + recorded_at: Wed, 29 Sep 2021 20:48:38 GMT +- request: + method: post + uri: https://api.dropboxapi.com/oauth2/token + body: + encoding: UTF-8 + string: client_id=CLIENT_ID&client_secret=CLIENT_SECRET&grant_type=refresh_token&refresh_token=MOCK_REFRESH_TOKEN + headers: + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/x-www-form-urlencoded + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + X-Server-Response-Time: + - '34' + Content-Type: + - text/javascript + Accept-Encoding: + - identity,gzip + Date: + - Wed, 29 Sep 2021 20:48:38 GMT + Server: + - envoy + Vary: + - Accept-Encoding + X-Dropbox-Response-Origin: + - far_remote + X-Dropbox-Request-Id: + - 8f86f70b4f50487396cf524e8df83765 + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"token_type": "bearer", "access_token": "MOCK_REFRESHED_ACCESS_TOKEN", + "expires_in": 14400}' + recorded_at: Wed, 29 Sep 2021 20:48:38 GMT +- request: + method: post + uri: https://api.dropboxapi.com/2/files/list_folder + body: + encoding: UTF-8 + string: '{"recursive":false,"include_media_info":false,"include_deleted":false,"path":""}' + headers: + Authorization: + - Bearer MOCK_REFRESHED_ACCESS_TOKEN + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/json + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + X-Server-Response-Time: + - '99' + Content-Type: + - application/json + Accept-Encoding: + - identity,gzip + Date: + - Wed, 29 Sep 2021 20:48:38 GMT + Server: + - envoy + Vary: + - Accept-Encoding + X-Dropbox-Response-Origin: + - far_remote + X-Dropbox-Request-Id: + - d130ea0765604bc5939453ffbce5a760 + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"entries": [{".tag": "folder", "name": "PleaseLetMeTest''s shared + workspace", "path_lower": "/pleaseletmetest''s shared workspace", "path_display": + "/PleaseLetMeTest''s shared workspace", "id": "id:L5U1_AOVa-QAAAAAAAA3-g"}, + {".tag": "folder", "name": "dropbox_api_fixtures", "path_lower": "/dropbox_api_fixtures", + "path_display": "/dropbox_api_fixtures", "id": "id:L5U1_AOVa-QAAAAAAAA3-w"}, + {".tag": "folder", "name": "Create Batch", "path_lower": "/create batch", + "path_display": "/Create Batch", "id": "id:L5U1_AOVa-QAAAAAAAA4oQ"}, {".tag": + "folder", "name": "Create Batch 1", "path_lower": "/create batch 1", "path_display": + "/Create Batch 1", "id": "id:L5U1_AOVa-QAAAAAAAA4og"}, {".tag": "folder", + "name": "Create Batch 1 (1)", "path_lower": "/create batch 1 (1)", "path_display": + "/Create Batch 1 (1)", "id": "id:L5U1_AOVa-QAAAAAAAA4ow"}, {".tag": "folder", + "name": "arizona_baby", "path_lower": "/arizona_baby", "path_display": "/arizona_baby", + "id": "id:L5U1_AOVa-QAAAAAAAA4pA"}, {".tag": "folder", "name": "b.jpg", "path_lower": + "/b.jpg", "path_display": "/b.jpg", "id": "id:L5U1_AOVa-QAAAAAAAA4pQ"}, {".tag": + "folder", "name": "Homework", "path_lower": "/homework", "path_display": "/Homework", + "id": "id:L5U1_AOVa-QAAAAAAAA4qA"}, {".tag": "file", "name": "target.txt", + "path_lower": "/target.txt", "path_display": "/target.txt", "id": "id:L5U1_AOVa-QAAAAAAAA4pg", + "client_modified": "2021-02-07T01:09:05Z", "server_modified": "2021-02-07T01:09:05Z", + "rev": "5bab4b3222c52043720ae", "size": 22, "is_downloadable": true, "content_hash": + "2064faa877255c7097e19c8ce5daada411478d0bfb8ed57837eeaa53bd4a10b3"}, {".tag": + "file", "name": "file.zip", "path_lower": "/file.zip", "path_display": "/file.zip", + "id": "id:L5U1_AOVa-QAAAAAAAA4rQ", "client_modified": "2021-02-07T01:10:00Z", + "server_modified": "2021-02-07T01:11:10Z", "rev": "5bab4ba9864db043720ae", + "size": 1073741824, "is_downloadable": true, "content_hash": "0ade23b455a4127f8626e570875abdf248625c4df8246a9578e25f6d8bf0aed2"}], + "cursor": "AAEMXGRO5DnecQDu-j8p7QDOY5TXLDvoT3XLPTeCmOrZtIJW-HhdqTEVuZXe0vIAcn74onEW_W4g5DiowdJrfZJRl-8djP7KKTqK5FXXt0VHVfeC4WGFWqidh18HveyPvtDoM5VALkWABhaDJXS3t_t4CLVnha776YW1Dh-qPPlrT1r6WeASkYooXgaEWNhklZ8", + "has_more": false}' + recorded_at: Wed, 29 Sep 2021 20:48:39 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/client_with_namespace_id.yml b/spec/fixtures/vcr_cassettes/client_with_namespace_id.yml new file mode 100644 index 00000000..d47d20d0 --- /dev/null +++ b/spec/fixtures/vcr_cassettes/client_with_namespace_id.yml @@ -0,0 +1,75 @@ +--- +http_interactions: +- request: + method: post + uri: https://api.dropboxapi.com/2/files/list_folder + body: + encoding: UTF-8 + string: '{"recursive":false,"include_media_info":false,"include_deleted":false,"path":"/dropbox_api_fixtures"}' + headers: + Authorization: + - Bearer MOCK_AUTHORIZATION_BEARER + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/json + Dropbox-Api-Path-Root: + - '{".tag": "namespace_id", "namespace_id": "70721710"}' + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache + Content-Type: + - application/json + Date: + - Sun, 07 Feb 2021 17:52:42 GMT + Pragma: + - no-cache + Server: + - envoy + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + X-Server-Response-Time: + - '131' + Vary: + - Accept-Encoding + X-Dropbox-Request-Id: + - 5f802a722df244b4ac1008d639d95b18 + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"entries": [{".tag": "folder", "name": "chunked_uploader", "path_lower": + "/dropbox_api_fixtures/chunked_uploader", "path_display": "/dropbox_api_fixtures/chunked_uploader", + "id": "id:L5U1_AOVa-QAAAAAAAA4cA"}, {".tag": "folder", "name": "get_metadata", + "path_lower": "/dropbox_api_fixtures/get_metadata", "path_display": "/dropbox_api_fixtures/get_metadata", + "id": "id:L5U1_AOVa-QAAAAAAAA4ig"}, {".tag": "folder", "name": "get_thumbnail_batch", + "path_lower": "/dropbox_api_fixtures/get_thumbnail_batch", "path_display": + "/dropbox_api_fixtures/get_thumbnail_batch", "id": "id:L5U1_AOVa-QAAAAAAAA4jg"}, + {".tag": "folder", "name": "get_shared_link_metadata", "path_lower": "/dropbox_api_fixtures/get_shared_link_metadata", + "path_display": "/dropbox_api_fixtures/get_shared_link_metadata", "id": "id:L5U1_AOVa-QAAAAAAAA4kA"}, + {".tag": "folder", "name": "copy_batch", "path_lower": "/dropbox_api_fixtures/copy_batch", + "path_display": "/dropbox_api_fixtures/copy_batch", "id": "id:L5U1_AOVa-QAAAAAAAA4kw"}, + {".tag": "folder", "name": "create_file_request", "path_lower": "/dropbox_api_fixtures/create_file_request", + "path_display": "/dropbox_api_fixtures/create_file_request", "id": "id:L5U1_AOVa-QAAAAAAAA4lg"}, + {".tag": "folder", "name": "delete", "path_lower": "/dropbox_api_fixtures/delete", + "path_display": "/dropbox_api_fixtures/delete", "id": "id:L5U1_AOVa-QAAAAAAAA4mA"}, + {".tag": "folder", "name": "list_folder", "path_lower": "/dropbox_api_fixtures/list_folder", + "path_display": "/dropbox_api_fixtures/list_folder", "id": "id:L5U1_AOVa-QAAAAAAAA4ng"}, + {".tag": "folder", "name": "upload", "path_lower": "/dropbox_api_fixtures/upload", + "path_display": "/dropbox_api_fixtures/upload", "id": "id:L5U1_AOVa-QAAAAAAAA4qw"}, + {".tag": "folder", "name": "search", "path_lower": "/dropbox_api_fixtures/search", + "path_display": "/dropbox_api_fixtures/search", "id": "id:L5U1_AOVa-QAAAAAAAA4sQ"}], + "cursor": "AAEmtUf7rHy0z1_fYArj36RUfnoTTCdp3QzlAlWoY9SbhGKHKpqmFjyskrVZSZcQrnJwd98VFmM-mfW2W4eEN4XM6MoFpifOGCXR6a0aqib2uaHWZseMtfrDEbihpeIjg4nGNB24BH41q3rvHzEaZWTFQhmUpkF6PtLRFCnx0tegb8jTTMZlYBCoL-JbiH4TQZyR9ee10vedEEu8pi8zWuuEWow5aCCrrKN-2ZEgpTEJqxvN61qIHvHlWdpiO1nesPM", + "has_more": false}' + recorded_at: Sun, 07 Feb 2021 17:52:42 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/download/success.yml b/spec/fixtures/vcr_cassettes/download/success.yml index 4d650010..0c153d96 100644 --- a/spec/fixtures/vcr_cassettes/download/success.yml +++ b/spec/fixtures/vcr_cassettes/download/success.yml @@ -50,7 +50,7 @@ http_interactions: - '{"name": "file.txt", "path_lower": "/file.txt", "path_display": "/file.txt", "id": "id:evvfE6q6cK0AAAAAAAACKQ", "client_modified": "2016-10-22T08:41:34Z", "server_modified": "2016-10-22T08:41:34Z", "rev": "1ab624061bdd", "size": - 14}' + 12}' X-Server-Response-Time: - '227' X-Dropbox-Request-Id: @@ -59,7 +59,7 @@ http_interactions: - noindex, nofollow, noimageindex body: encoding: UTF-8 - string: "Viva Rusia!\n" + string: "Hola Leo!\n" http_version: recorded_at: Sun, 11 Dec 2016 11:39:25 GMT recorded_with: VCR 3.0.1 diff --git a/spec/fixtures/vcr_cassettes/get_current_account/success.yml b/spec/fixtures/vcr_cassettes/get_current_account/success.yml index 63b41378..64e6653b 100644 --- a/spec/fixtures/vcr_cassettes/get_current_account/success.yml +++ b/spec/fixtures/vcr_cassettes/get_current_account/success.yml @@ -10,7 +10,7 @@ http_interactions: Authorization: - Bearer MOCK_AUTHORIZATION_BEARER User-Agent: - - Faraday v0.9.2 + - Faraday v1.0.0 Content-Type: - application/json Accept-Encoding: @@ -22,41 +22,36 @@ http_interactions: code: 200 message: OK headers: - Server: - - nginx - Date: - - Sun, 23 Oct 2016 21:47:14 GMT - Content-Type: - - application/json - Content-Length: - - '401' - Connection: - - keep-alive Cache-Control: - no-cache + Content-Type: + - application/json + Date: + - Sun, 07 Feb 2021 16:37:43 GMT Pragma: - no-cache - Set-Cookie: - - gvc=MzA3OTc2NDI0NTUwMjI0Mjc1NzIxNDA2NzAxMjUyNTIzNzczNTAy; expires=Fri, 22 - Oct 2021 21:47:14 GMT; httponly; Path=/; secure + Server: + - envoy X-Content-Type-Options: - nosniff - X-Dropbox-Http-Protocol: - - None - X-Dropbox-Request-Id: - - 0ae5a6ad7da896aac63d297fc95f3e7f X-Frame-Options: - SAMEORIGIN X-Server-Response-Time: - - '79' + - '400' + Vary: + - Accept-Encoding + X-Dropbox-Request-Id: + - 267038e9bdb948cebc813e139ae02533 + Transfer-Encoding: + - chunked body: - encoding: UTF-8 - string: '{"account_id": "dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs", "name": - {"given_name": "Jesus", "surname": "Burgos", "familiar_name": "Jesus", "display_name": - "Jesus Burgos", "abbreviated_name": "JB"}, "email": "a3241659@drdrb.net", - "email_verified": true, "disabled": false, "country": "ES", "locale": "en", - "referral_link": "https://db.tt/ZBhfNSRz", "is_paired": false, "account_type": - {".tag": "basic"}}' - http_version: - recorded_at: Sun, 23 Oct 2016 21:47:14 GMT -recorded_with: VCR 3.0.1 + encoding: ASCII-8BIT + string: '{"account_id": "dbid:AABOLtA1rT6rRK4vajKZrWqLZ7wVnV863u4", "name": + {"given_name": "Jes\u00fas", "surname": "Burgos", "familiar_name": "Jes\u00fas", + "display_name": "Jes\u00fas Burgos", "abbreviated_name": "JB"}, "email": "jburmac@gmail.com", + "email_verified": true, "disabled": false, "country": "ES", "locale": "es-ES", + "referral_link": "https://www.dropbox.com/referrals/AAAPVkAVLJ_KOkom5veU5p5i20nxosCIg9c?src=app9-9859360", + "is_paired": false, "account_type": {".tag": "basic"}, "root_info": {".tag": + "user", "root_namespace_id": "70721710", "home_namespace_id": "70721710"}}' + recorded_at: Sun, 07 Feb 2021 16:37:44 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/list_folder/invalid_namespace_id.yml b/spec/fixtures/vcr_cassettes/list_folder/invalid_namespace_id.yml new file mode 100644 index 00000000..1921ecb6 --- /dev/null +++ b/spec/fixtures/vcr_cassettes/list_folder/invalid_namespace_id.yml @@ -0,0 +1,45 @@ +--- +http_interactions: +- request: + method: post + uri: https://api.dropboxapi.com/2/files/list_folder + body: + encoding: UTF-8 + string: '{"recursive":false,"include_media_info":false,"include_deleted":false,"path":"/dropbox_api_fixtures"}' + headers: + Authorization: + - Bearer MOCK_AUTHORIZATION_BEARER + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/json + Dropbox-Api-Path-Root: + - '{".tag": "namespace_id", "namespace_id": "938429923"}' + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 422 + message: Unprocessable Entity + headers: + Content-Security-Policy: + - sandbox allow-forms allow-scripts + Content-Type: + - application/json + Date: + - Sun, 07 Feb 2021 18:16:10 GMT + Server: + - envoy + Vary: + - Accept-Encoding + X-Dropbox-Request-Id: + - f99de91c622d42338d3fa3bdc30a2bb9 + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"error_summary": "no_permission/..", "error": {".tag": "no_permission"}}' + recorded_at: Sun, 07 Feb 2021 18:16:10 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/list_folder/success_with_namespace_id.yml b/spec/fixtures/vcr_cassettes/list_folder/success_with_namespace_id.yml new file mode 100644 index 00000000..931dcadc --- /dev/null +++ b/spec/fixtures/vcr_cassettes/list_folder/success_with_namespace_id.yml @@ -0,0 +1,75 @@ +--- +http_interactions: +- request: + method: post + uri: https://api.dropboxapi.com/2/files/list_folder + body: + encoding: UTF-8 + string: '{"recursive":false,"include_media_info":false,"include_deleted":false,"path":"/dropbox_api_fixtures"}' + headers: + Authorization: + - Bearer MOCK_AUTHORIZATION_BEARER + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/json + Dropbox-Api-Path-Root: + - '{".tag": "namespace_id", "namespace_id": "70721710"}' + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache + Content-Type: + - application/json + Date: + - Sun, 07 Feb 2021 18:16:10 GMT + Pragma: + - no-cache + Server: + - envoy + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + X-Server-Response-Time: + - '104' + Vary: + - Accept-Encoding + X-Dropbox-Request-Id: + - f94af4eae2f54ec48d3eb77b96cedef3 + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"entries": [{".tag": "folder", "name": "chunked_uploader", "path_lower": + "/dropbox_api_fixtures/chunked_uploader", "path_display": "/dropbox_api_fixtures/chunked_uploader", + "id": "id:L5U1_AOVa-QAAAAAAAA4cA"}, {".tag": "folder", "name": "get_metadata", + "path_lower": "/dropbox_api_fixtures/get_metadata", "path_display": "/dropbox_api_fixtures/get_metadata", + "id": "id:L5U1_AOVa-QAAAAAAAA4ig"}, {".tag": "folder", "name": "get_thumbnail_batch", + "path_lower": "/dropbox_api_fixtures/get_thumbnail_batch", "path_display": + "/dropbox_api_fixtures/get_thumbnail_batch", "id": "id:L5U1_AOVa-QAAAAAAAA4jg"}, + {".tag": "folder", "name": "get_shared_link_metadata", "path_lower": "/dropbox_api_fixtures/get_shared_link_metadata", + "path_display": "/dropbox_api_fixtures/get_shared_link_metadata", "id": "id:L5U1_AOVa-QAAAAAAAA4kA"}, + {".tag": "folder", "name": "copy_batch", "path_lower": "/dropbox_api_fixtures/copy_batch", + "path_display": "/dropbox_api_fixtures/copy_batch", "id": "id:L5U1_AOVa-QAAAAAAAA4kw"}, + {".tag": "folder", "name": "create_file_request", "path_lower": "/dropbox_api_fixtures/create_file_request", + "path_display": "/dropbox_api_fixtures/create_file_request", "id": "id:L5U1_AOVa-QAAAAAAAA4lg"}, + {".tag": "folder", "name": "delete", "path_lower": "/dropbox_api_fixtures/delete", + "path_display": "/dropbox_api_fixtures/delete", "id": "id:L5U1_AOVa-QAAAAAAAA4mA"}, + {".tag": "folder", "name": "list_folder", "path_lower": "/dropbox_api_fixtures/list_folder", + "path_display": "/dropbox_api_fixtures/list_folder", "id": "id:L5U1_AOVa-QAAAAAAAA4ng"}, + {".tag": "folder", "name": "upload", "path_lower": "/dropbox_api_fixtures/upload", + "path_display": "/dropbox_api_fixtures/upload", "id": "id:L5U1_AOVa-QAAAAAAAA4qw"}, + {".tag": "folder", "name": "search", "path_lower": "/dropbox_api_fixtures/search", + "path_display": "/dropbox_api_fixtures/search", "id": "id:L5U1_AOVa-QAAAAAAAA4sQ"}], + "cursor": "AAHw8vonk_qkcfFTB291YR_xmoB2kiPTN-IhGkaWthzPm55mcxdIBEFv3mm9vK5h7L7PjIxvZaAkjDI14VGkC_AhT-saRUDI5uAWhUpdwDKgeK0CSWT2OOmM9WhmLplpkJT6ffhaSmgL4b2ep2tzvvP78GAZBAOLvloVavKgRyDrN8WAuX23nWMXlP4iaRAtiJIv6j7QitBbrn66oNLHc9N3x8kDElkXRMAD3tQlNFFj195o6lb-gB1KWRCc1LONTv0", + "has_more": false}' + recorded_at: Sun, 07 Feb 2021 18:16:10 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/list_folder/unset_namespace_id.yml b/spec/fixtures/vcr_cassettes/list_folder/unset_namespace_id.yml new file mode 100644 index 00000000..638decac --- /dev/null +++ b/spec/fixtures/vcr_cassettes/list_folder/unset_namespace_id.yml @@ -0,0 +1,145 @@ +--- +http_interactions: +- request: + method: post + uri: https://api.dropboxapi.com/2/files/list_folder + body: + encoding: UTF-8 + string: '{"recursive":false,"include_media_info":false,"include_deleted":false,"path":"/dropbox_api_fixtures"}' + headers: + Authorization: + - Bearer MOCK_AUTHORIZATION_BEARER + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/json + Dropbox-Api-Path-Root: + - '{".tag": "namespace_id", "namespace_id": "70721710"}' + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache + Content-Type: + - application/json + Date: + - Sun, 07 Feb 2021 18:16:11 GMT + Pragma: + - no-cache + Server: + - envoy + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + X-Server-Response-Time: + - '112' + Vary: + - Accept-Encoding + X-Dropbox-Request-Id: + - 8b74eafb14de498eafd766134e1b463e + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"entries": [{".tag": "folder", "name": "chunked_uploader", "path_lower": + "/dropbox_api_fixtures/chunked_uploader", "path_display": "/dropbox_api_fixtures/chunked_uploader", + "id": "id:L5U1_AOVa-QAAAAAAAA4cA"}, {".tag": "folder", "name": "get_metadata", + "path_lower": "/dropbox_api_fixtures/get_metadata", "path_display": "/dropbox_api_fixtures/get_metadata", + "id": "id:L5U1_AOVa-QAAAAAAAA4ig"}, {".tag": "folder", "name": "get_thumbnail_batch", + "path_lower": "/dropbox_api_fixtures/get_thumbnail_batch", "path_display": + "/dropbox_api_fixtures/get_thumbnail_batch", "id": "id:L5U1_AOVa-QAAAAAAAA4jg"}, + {".tag": "folder", "name": "get_shared_link_metadata", "path_lower": "/dropbox_api_fixtures/get_shared_link_metadata", + "path_display": "/dropbox_api_fixtures/get_shared_link_metadata", "id": "id:L5U1_AOVa-QAAAAAAAA4kA"}, + {".tag": "folder", "name": "copy_batch", "path_lower": "/dropbox_api_fixtures/copy_batch", + "path_display": "/dropbox_api_fixtures/copy_batch", "id": "id:L5U1_AOVa-QAAAAAAAA4kw"}, + {".tag": "folder", "name": "create_file_request", "path_lower": "/dropbox_api_fixtures/create_file_request", + "path_display": "/dropbox_api_fixtures/create_file_request", "id": "id:L5U1_AOVa-QAAAAAAAA4lg"}, + {".tag": "folder", "name": "delete", "path_lower": "/dropbox_api_fixtures/delete", + "path_display": "/dropbox_api_fixtures/delete", "id": "id:L5U1_AOVa-QAAAAAAAA4mA"}, + {".tag": "folder", "name": "list_folder", "path_lower": "/dropbox_api_fixtures/list_folder", + "path_display": "/dropbox_api_fixtures/list_folder", "id": "id:L5U1_AOVa-QAAAAAAAA4ng"}, + {".tag": "folder", "name": "upload", "path_lower": "/dropbox_api_fixtures/upload", + "path_display": "/dropbox_api_fixtures/upload", "id": "id:L5U1_AOVa-QAAAAAAAA4qw"}, + {".tag": "folder", "name": "search", "path_lower": "/dropbox_api_fixtures/search", + "path_display": "/dropbox_api_fixtures/search", "id": "id:L5U1_AOVa-QAAAAAAAA4sQ"}], + "cursor": "AAGWkxh7nbOaoX1pZDSeU6u3pRYQhoKMho2uhGSpgtqIrBCy6LhndIinfiGRj9w-lDP6sptWgPynQh_mjMe0iKcgIhlOYkaJ8wupppyPCoCDmjkUFgbfpay3KwZ3Dnoe3ZBR-6GHxpbLxWZ4AXvHmeRe3zWoI6uQ8vTccuMj9Q0uD3t4JZib_cHzDpbJpeTVZQEBLVB1aslUB41dT4RFdmpzI1E5wJpewAw83cqwUeooOCHPStJ3qXOl_G0q-k0qyvc", + "has_more": false}' + recorded_at: Sun, 07 Feb 2021 18:16:11 GMT +- request: + method: post + uri: https://api.dropboxapi.com/2/files/list_folder + body: + encoding: UTF-8 + string: '{"recursive":false,"include_media_info":false,"include_deleted":false,"path":"/dropbox_api_fixtures"}' + headers: + Authorization: + - Bearer MOCK_AUTHORIZATION_BEARER + User-Agent: + - Faraday v1.3.0 + Content-Type: + - application/json + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache + Content-Type: + - application/json + Date: + - Sun, 07 Feb 2021 18:16:11 GMT + Pragma: + - no-cache + Server: + - envoy + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + X-Server-Response-Time: + - '113' + Vary: + - Accept-Encoding + X-Dropbox-Request-Id: + - 5e397bcfc34e420dbd28e2df9f0bde08 + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"entries": [{".tag": "folder", "name": "chunked_uploader", "path_lower": + "/dropbox_api_fixtures/chunked_uploader", "path_display": "/dropbox_api_fixtures/chunked_uploader", + "id": "id:L5U1_AOVa-QAAAAAAAA4cA"}, {".tag": "folder", "name": "get_metadata", + "path_lower": "/dropbox_api_fixtures/get_metadata", "path_display": "/dropbox_api_fixtures/get_metadata", + "id": "id:L5U1_AOVa-QAAAAAAAA4ig"}, {".tag": "folder", "name": "get_thumbnail_batch", + "path_lower": "/dropbox_api_fixtures/get_thumbnail_batch", "path_display": + "/dropbox_api_fixtures/get_thumbnail_batch", "id": "id:L5U1_AOVa-QAAAAAAAA4jg"}, + {".tag": "folder", "name": "get_shared_link_metadata", "path_lower": "/dropbox_api_fixtures/get_shared_link_metadata", + "path_display": "/dropbox_api_fixtures/get_shared_link_metadata", "id": "id:L5U1_AOVa-QAAAAAAAA4kA"}, + {".tag": "folder", "name": "copy_batch", "path_lower": "/dropbox_api_fixtures/copy_batch", + "path_display": "/dropbox_api_fixtures/copy_batch", "id": "id:L5U1_AOVa-QAAAAAAAA4kw"}, + {".tag": "folder", "name": "create_file_request", "path_lower": "/dropbox_api_fixtures/create_file_request", + "path_display": "/dropbox_api_fixtures/create_file_request", "id": "id:L5U1_AOVa-QAAAAAAAA4lg"}, + {".tag": "folder", "name": "delete", "path_lower": "/dropbox_api_fixtures/delete", + "path_display": "/dropbox_api_fixtures/delete", "id": "id:L5U1_AOVa-QAAAAAAAA4mA"}, + {".tag": "folder", "name": "list_folder", "path_lower": "/dropbox_api_fixtures/list_folder", + "path_display": "/dropbox_api_fixtures/list_folder", "id": "id:L5U1_AOVa-QAAAAAAAA4ng"}, + {".tag": "folder", "name": "upload", "path_lower": "/dropbox_api_fixtures/upload", + "path_display": "/dropbox_api_fixtures/upload", "id": "id:L5U1_AOVa-QAAAAAAAA4qw"}, + {".tag": "folder", "name": "search", "path_lower": "/dropbox_api_fixtures/search", + "path_display": "/dropbox_api_fixtures/search", "id": "id:L5U1_AOVa-QAAAAAAAA4sQ"}], + "cursor": "AAGZvE433TKRmUhISjIItQWGkjpbrA1IeTYZRRW87-yd_Gm9w8tOn3KiYjZRcbdXj6GDTD8bdBAILRRDjnNgS9WOl2Q_4-ky0528T3yy1IBsVC8hLAMEGJiDAeGiWW0qS_qTlw4wRME-PJuOrf2Q-CgsYQtnhYbS4n8wLN-wal1SWlL8TO7i0O9GAJJwkInTkgfXr78Ktt841YuvOiRXnL29BD4NJ6q0wrvUmphHzYRQOC2ORM-AbEB34iQGR8PUZzo", + "has_more": false}' + recorded_at: Sun, 07 Feb 2021 18:16:11 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/list_folder_longpoll/list_folder.yml b/spec/fixtures/vcr_cassettes/list_folder_longpoll/list_folder.yml index 6e605c2c..de5473cb 100644 --- a/spec/fixtures/vcr_cassettes/list_folder_longpoll/list_folder.yml +++ b/spec/fixtures/vcr_cassettes/list_folder_longpoll/list_folder.yml @@ -5,12 +5,12 @@ http_interactions: uri: https://api.dropboxapi.com/2/files/list_folder body: encoding: UTF-8 - string: '{"recursive":false,"include_media_info":false,"include_deleted":false,"path":""}' + string: '{"recursive":false,"include_media_info":false,"include_deleted":false,"path":"/dropbox_api_fixtures/list_folder_longpoll"}' headers: Authorization: - Bearer MOCK_AUTHORIZATION_BEARER User-Agent: - - Faraday v0.9.2 + - Faraday v1.3.0 Content-Type: - application/json Accept-Encoding: @@ -22,119 +22,33 @@ http_interactions: code: 200 message: OK headers: - Server: - - nginx - Date: - - Sun, 11 Dec 2016 11:49:27 GMT - Content-Type: - - application/json - Transfer-Encoding: - - chunked - Connection: - - keep-alive Cache-Control: - no-cache - Pragma: - - no-cache - Set-Cookie: - - gvc=MTIwNTkxMjU5MDE4NzA2NjYwNjE4OTkwNTc1Mzc5MjM4MzYxNTQw; expires=Fri, 10 - Dec 2021 11:49:27 GMT; httponly; Path=/; secure - User-Agent: - - '' X-Content-Type-Options: - nosniff - X-Dropbox-Http-Protocol: - - None - X-Dropbox-Request-Id: - - 34a3c76421df38c7f87ddde709cc9950 X-Frame-Options: - SAMEORIGIN X-Server-Response-Time: - - '192' + - '70' + Content-Type: + - application/json + Accept-Encoding: + - identity,gzip + Date: + - Sun, 27 Feb 2022 13:43:30 GMT + Server: + - envoy + Vary: + - Accept-Encoding + X-Dropbox-Response-Origin: + - far_remote + X-Dropbox-Request-Id: + - 8e82e23b85d64ca6a7c055061e4d2a18 + Transfer-Encoding: + - chunked body: encoding: ASCII-8BIT - string: '{"entries": [{".tag": "folder", "name": "3D ordering platform (development)", - "path_lower": "/3d ordering platform (development)", "path_display": "/3D - ordering platform (development)", "id": "id:evvfE6q6cK0AAAAAAAAASA"}, {".tag": - "folder", "name": "File requests", "path_lower": "/file requests", "path_display": - "/File requests", "id": "id:evvfE6q6cK0AAAAAAAAB2A"}, {".tag": "folder", "name": - "#0336 New Office", "path_lower": "/#0336 new office", "path_display": "/#0336 - New Office", "id": "id:evvfE6q6cK0AAAAAAAAB2g", "shared_folder_id": "1087883416", - "sharing_info": {"read_only": false, "shared_folder_id": "1087883416"}}, {".tag": - "folder", "name": "test", "path_lower": "/test", "path_display": "/test", - "id": "id:VX06BhYxrHAAAAAAAAAAAQ"}, {".tag": "folder", "name": "folder_a", - "path_lower": "/folder_a", "path_display": "/folder_a", "id": "id:HiVAYHwecGAAAAAAAAAAAQ", - "shared_folder_id": "1231273663", "sharing_info": {"read_only": false, "shared_folder_id": - "1231273663"}}, {".tag": "folder", "name": "folder_b", "path_lower": "/folder_b", - "path_display": "/folder_b", "id": "id:XyfnfucXK0AAAAAAAAAAAQ", "shared_folder_id": - "1236358158", "sharing_info": {"read_only": false, "shared_folder_id": "1236358158"}}, - {".tag": "folder", "name": "folder", "path_lower": "/folder", "path_display": - "/folder", "id": "id:uxGjY685ysAAAAAAAAAAAQ", "shared_folder_id": "1236389908", - "sharing_info": {"read_only": false, "shared_folder_id": "1236389908"}}, {".tag": - "folder", "name": "folder_c", "path_lower": "/folder_c", "path_display": "/folder_c", - "id": "id:TdTNRdDJe5AAAAAAAAAAAQ", "shared_folder_id": "1236412598", "sharing_info": - {"read_only": false, "shared_folder_id": "1236412598"}}, {".tag": "folder", - "name": "test_folder", "path_lower": "/test_folder", "path_display": "/test_folder", - "id": "id:evvfE6q6cK0AAAAAAAAB7g", "shared_folder_id": "1236413110", "sharing_info": - {"read_only": false, "shared_folder_id": "1236413110"}}, {".tag": "folder", - "name": "folder_k", "path_lower": "/folder_k", "path_display": "/folder_k", - "id": "id:WVMBeIiOHYAAAAAAAAAAAQ", "shared_folder_id": "1236414195", "sharing_info": - {"read_only": false, "shared_folder_id": "1236414195"}}, {".tag": "folder", - "name": "some_folder", "path_lower": "/some_folder", "path_display": "/some_folder", - "id": "id:PaoFyFBdjBAAAAAAAAAAAQ"}, {".tag": "folder", "name": "folder_for_sharing", - "path_lower": "/folder_for_sharing", "path_display": "/folder_for_sharing", - "id": "id:mLkl0_I63QAAAAAAAAAAAQ"}, {".tag": "folder", "name": "Apps", "path_lower": - "/apps", "path_display": "/Apps", "id": "id:evvfE6q6cK0AAAAAAAAB8Q"}, {".tag": - "folder", "name": "3d orders", "path_lower": "/3d orders", "path_display": - "/3d orders", "id": "id:evvfE6q6cK0AAAAAAAAB9g"}, {".tag": "folder", "name": - "Orders (dev)", "path_lower": "/orders (dev)", "path_display": "/Orders (dev)", - "id": "id:evvfE6q6cK0AAAAAAAACCw"}, {".tag": "folder", "name": "Orders (test)", - "path_lower": "/orders (test)", "path_display": "/Orders (test)", "id": "id:evvfE6q6cK0AAAAAAAACDQ"}, - {".tag": "folder", "name": "3D ordering platform", "path_lower": "/3d ordering - platform", "path_display": "/3D ordering platform", "id": "id:evvfE6q6cK0AAAAAAAACHQ"}, - {".tag": "folder", "name": "upload-test", "path_lower": "/upload-test", "path_display": - "/upload-test", "id": "id:evvfE6q6cK0AAAAAAAADVw"}, {".tag": "folder", "name": - "Library (dev)", "path_lower": "/library (dev)", "path_display": "/Library - (dev)", "id": "id:evvfE6q6cK0AAAAAAAAD2A"}, {".tag": "folder", "name": "some", - "path_lower": "/some", "path_display": "/some", "id": "id:evvfE6q6cK0AAAAAAAAD8g"}, - {".tag": "folder", "name": "a", "path_lower": "/a", "path_display": "/a", - "id": "id:evvfE6q6cK0AAAAAAAAD8w"}, {".tag": "file", "name": "a.jpg", "path_lower": - "/a.jpg", "path_display": "/a.jpg", "id": "id:evvfE6q6cK0AAAAAAAAB2w", "client_modified": - "2016-04-09T15:47:32Z", "server_modified": "2016-04-09T15:47:38Z", "rev": - "28924061bdd", "size": 396317}, {".tag": "file", "name": "bsd.pdf", "path_lower": - "/bsd.pdf", "path_display": "/bsd.pdf", "id": "id:XjvW7ncTHSAAAAAAAAAAAQ", - "client_modified": "2016-05-22T09:28:05Z", "server_modified": "2016-05-22T09:28:06Z", - "rev": "2c424061bdd", "size": 701667}, {".tag": "file", "name": "image.png", - "path_lower": "/image.png", "path_display": "/image.png", "id": "id:jVVdzRI3CnAAAAAAAAAAAQ", - "client_modified": "2016-05-22T09:29:22Z", "server_modified": "2016-06-04T08:36:02Z", - "rev": "1a4524061bdd", "size": 77019}, {".tag": "file", "name": "file_for_sharing.docx", - "path_lower": "/file_for_sharing.docx", "path_display": "/file_for_sharing.docx", - "id": "id:oeWs1qkP7PAAAAAAAAAAAQ", "client_modified": "2016-05-22T09:37:23Z", - "server_modified": "2016-06-22T13:22:02Z", "rev": "1a6924061bdd", "size": - 227514}, {".tag": "file", "name": "ffff.txt", "path_lower": "/ffff.txt", "path_display": - "/ffff.txt", "id": "id:APHay3AIfcAAAAAAAAAAAQ", "client_modified": "2016-07-16T11:24:39Z", - "server_modified": "2016-07-16T11:24:39Z", "rev": "1a6c24061bdd", "size": - 4}, {".tag": "file", "name": "test.txt", "path_lower": "/test.txt", "path_display": - "/test.txt", "id": "id:evvfE6q6cK0AAAAAAAAB8w", "client_modified": "2016-10-18T16:24:49Z", - "server_modified": "2016-10-18T16:24:49Z", "rev": "1a7424061bdd", "size": - 4}, {".tag": "file", "name": "file.txt", "path_lower": "/file.txt", "path_display": - "/file.txt", "id": "id:evvfE6q6cK0AAAAAAAACKQ", "client_modified": "2016-10-22T08:41:34Z", - "server_modified": "2016-10-22T08:41:34Z", "rev": "1ab624061bdd", "size": - 14}, {".tag": "file", "name": "dapvqfrwnb.txt", "path_lower": "/dapvqfrwnb.txt", - "path_display": "/dapvqfrwnb.txt", "id": "id:evvfE6q6cK0AAAAAAAADPA", "client_modified": - "2016-10-31T15:54:57Z", "server_modified": "2016-10-31T15:54:57Z", "rev": - "1bd324061bdd", "size": 10}, {".tag": "file", "name": "ruby-classes.png", - "path_lower": "/ruby-classes.png", "path_display": "/ruby-classes.png", "id": - "id:evvfE6q6cK0AAAAAAAAEGw", "client_modified": "2016-11-28T17:56:56Z", "server_modified": - "2016-11-28T17:56:56Z", "rev": "1d6c24061bdd", "size": 62866}, {".tag": "file", - "name": "ruby-classes-2.png", "path_lower": "/ruby-classes-2.png", "path_display": - "/ruby-classes-2.png", "id": "id:evvfE6q6cK0AAAAAAAAEHA", "client_modified": - "2016-11-28T18:02:42Z", "server_modified": "2016-11-28T18:02:42Z", "rev": - "1d6d24061bdd", "size": 62866}, {".tag": "file", "name": "file-2.txt", "path_lower": - "/file-2.txt", "path_display": "/file-2.txt", "id": "id:evvfE6q6cK0AAAAAAAAEHQ", - "client_modified": "2016-11-28T18:08:31Z", "server_modified": "2016-11-28T18:08:31Z", - "rev": "1d6e24061bdd", "size": 24}], "cursor": "AAFToNAroSgzIMkMZsT88-VRF-iVwMmoEBwCreuyqURc4d7ctAOnAEKuHYzaldceDeUgemxXLm5jsKpcT_TBSm0x3yNMW5DALIDlLynBOvxL8E8k2w-EYL1BeJrP6o1ZW-ScH1fN-BDcp3zkPVYFHLySF3rjTSw2rv2U0fAfRl0XJceLVnXTpHxh8vs43EPjJUyZsMOhEm0GuJ5NiNrEob4Rtz3HdTdCoxbZtllD_LtgPoAdP-XNjq_qUtmZj08l6P6NSi2A4Qmum6d3y8DOWjX56-_oySBdXvxo5YgNEzHGHJ8BUbAxT20y3LKH0SWu3-l7s9642B5VvsZhX48Ti8R0tCuLevu27ikAmeYb-dLMRC_uDjSG8-0BBu8I3LdGux7lGOu6ki872kvko6FsKicvvcnOYhpIu3KqzfeSUQiPR-KXWJCT5vHX7dcLbKJUeRYxlQqqPRYGYXutWGcWmrdlNI3jL9_v12pHEpKK4vCWzX4S5T99KdHWVboRXUl5VvQ4qH8UxblbqGvm6NgC6iOm95qDIv-yf8jTRB1qYeWVDOPZT5rFfAXUY26uW7PFwZ2siu_xphvT--52ByxnGuR0TEVhYptdUrC9a3feMeDIygkyTLeH7q-WBCU7eFXiIvCXo1zGMaSFNmpYCnCyhGBqK70k1dR9ftMKo1xlRkIK4gM9pE-MWXVAk6ow1BG6SGtoHq624oNFDBPnOn_CBTdzUO9pvoFXkk3Oe-d6DMkRAXxzv4JUDqRtkyYqLq9cfIRJBExYBUD3nknF9iEAOoymYZad9kpQnmS4Oc2GtD8-mdk2WcV_rPuYd7lHFhYzJ3y0w_wipOHEfKEuBEoaflF7aIpFl3dLx31LuBeW4t5__Cnk4uZnw6fcTZ_P3DGx3q0tL4wPl-cCGz6A1AJIBZROlHPls51Oq45fyStU7AwS7vLfc_NWX-VOMtR5UxiFv7UC3dnaFSdN4Z2FQCW7fmHqCyXu6GKO536jo9tnT0eNqfxSTf7ztOKRjfh1o1euc8poKC-EnDUMYIl-EyJcYQ4XLUhroWpaKM8Us757j3ceIKXPYYqqXi60wFRzBlu_ufqttFG4wtPVqLxPjHAjgCzlDzyiJ7QmAmS2DNxx60Aw2J-fG9oHegLQVCHHE42LGt_uJeogBHMKQI1XF-XbslZ6Wo3PkF_Er8tU7jSue56AbTbCykYl9HR4ZCgdf9jAo7XUvCqrtVCspGV3HLj697wvK_rM-1MImEa9B7RJS3DbNSQ2vvuuoMLEGx5pj8DIreArUYSpyth1P1p2a63o4oka8f7M7peMUyfRRdXA3rLd2O3epvsi4V4PFrGcCeR_DfXwIIFVXmUnP0niL6fpKrfSKRgEO4QZFSTbr03IbSyJMg1FQ2RdKdLhiAREI17glfxLgVcvgbwTWi1RdreAToeOM3Iee3iT6SlMr_h5ASJ8crXVaQyZSYWw_TjsmsA2bCrhhOYhqDkVMrKkImCKWcFmluI5buUYOkazDJrr8n9Z-qx3dE2uhZS12iBkesqgxkk7nJ5Q2WoiCIbyaTJDjxZ69dX3xLq94zSfaHVxeehBTf8PE0W61Cq6b4grdut1QIB3YXrMJBHZU9cEbQyZwzl6Fz-BGtYy-JjCJA8MI-IppDg4kTeg2ot__m_WoeKU4iWyetLZ_UsfX9Y_XLNBpscQbOEjkxrIAFi9uZ0j7kl-Zu5hRkU_50UA3j5WPdpExZjNJcAPAZoey_Wh59wdCLmPeMzJO-Jb286oTj46ZP8FrrW0F8V9mAqZldY5MerQYI7JCK8I0uv5khaFXvFkk1UrMVW8j-17xJB5SoGNFrk6cPJgAtex5FnaefAotZN4DoC1kh595xRakiTNPsYH9vnxQiePHr9gPN4p6FpF1mFcImchjPWwZsLTPBI6E-Fp4KZW3Ll43p7_2-CJXR6lnVihKnOoCsyZ2QWKTtwqVYY82sv7EPHlyHf5KYZEAQMx2I3vZRNhIkYZyr3WjbB7uStRz74HgX2AfGrAXUJ0GrVM-UzNSSmccFjvRqZhHM57QmXAc0aNyb1Gef6a9EE0inSasTlU1jzrJd-ta2SXgqAtl2_uT2ml5lwOn_0EX4TZ_ayWTAA-bPJEOycni3CDezKIIN5HuycZ13aNhO_2v3TPCmXiBuM249AZViKCF5DLhi7cuTFsc_6YqABQGwXgVkXROxWpg6v0v4ZChh3dDKbNLXdmMJfQXDpk0Diy-nmBtKh2vfbeC1SoVMBFT68y7kO8Rrarg5U6yNozZ0a9qIQyQKnhZ1bgO6bQfJ9dz_edvhOSTDlnYJQJsoti-CHeIAhCofQQSL4vtfp_86GVLuiN1ryzwW3C90mM2o97kbPDOCQn-RK1rpagJ0griSWytHnVuuXlY6gWqa3hAP5RmI5VkaG94vEQgmu2TcjJEhUQUAw6KyxAWC499tiCJKk6QvVYVQfkVahltdOrt0OEK29DyGvfOimBkYkjDYTdYrV5Y1O7E_LkX5PxHl6PJnpDvuVbNtGvnnYpc1IfLDwigNY5hCERzRcCWUUl157KwsihrfpTo8q8_-gwryK0ryGs_IRjOf2I1GyPKD1hjiXIAW0PjSzNC1jRz9uvONNS9Jfq5Z1_jo0y_-y3k01IGljf9tya0x7NOzgGNJOPw4dCIAhJPZBCmyMfKJfFuSM-F3cVqHc5zLGYdoCniTcduCb91T0i8E8NgyoXQ_de3fujykMcJNbJAF6ufj_ap6bphDKhQzRadl6Scu5x1DzJEmJ1PENbQn-M5fePCgKebU6CvtNcglzxvYPFItHkONaq-1xFX-WIpFYtnvlPMyYUJu_zPg_RYwOh4h4BlasqtnIEuZukrDbFgu2Ryxa8cuucF0LxMYeHzMbj62OSeuW9dHl6ORFba-R5xfhOhDj8SiHE8ZuFDugvy3Y8gU3vvUiv25xDEgMxoSkp1v3AvxaK1z8sY95ExBC9B-N_HXrG1LEkdbx6FDB3YI3jnJ1n8D9l-WC9KaVu24yDrtezYiAGcCEaerPhu-qpcSsoKygpTFsll58yMhoElzeU0fomEjdx3Bie4zsxy85S-LHlvbuuZ7I6JFTSWIxjrcM7nlbWMP_zXP1DEzvS-PJZA7he9aJ9BnWs6m33uiuoYz9DfNs2JHpbtgfmgB6jnUo7UHeGj02P8Dlkxg", + string: '{"entries": [], "cursor": "AAF2APSHjtbXJqAdZ2Pvpaquig0syveLl4XonPXAZgil94KoBDdJ_RV_JTrndD3akjPZsa5XiX9P_1YaZ_dSH0fyZ6ffoRZk2gJ_gcR8cYhtXr68L_py2WZ-qTx2RBxdvM_AxbChl7DXzS4hbvUOsKyvrWO0q7s0EESd3fbS9R360FgYEOjy8KqwPkPKU3pkZjZ-B-y37sQOFLm3b8cNpC2yx0BxkeUEP4Yja8LXf20741Jm5tZUA12pLGetQyIB-z4xv3kIwCb6d1JPy2I_cZvJ6BQpN85-ryfxMLrh-ieppw", "has_more": false}' - http_version: - recorded_at: Sun, 11 Dec 2016 11:50:43 GMT -recorded_with: VCR 3.0.1 + recorded_at: Sun, 27 Feb 2022 13:43:30 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/list_folder_longpoll/reset.yml b/spec/fixtures/vcr_cassettes/list_folder_longpoll/reset.yml index 948e0c2d..db56dc27 100644 --- a/spec/fixtures/vcr_cassettes/list_folder_longpoll/reset.yml +++ b/spec/fixtures/vcr_cassettes/list_folder_longpoll/reset.yml @@ -8,7 +8,7 @@ http_interactions: string: '{"timeout":30,"cursor":"I believe in the blerch"}' headers: User-Agent: - - Faraday v0.9.2 + - Faraday v1.3.0 Content-Type: - application/json Accept-Encoding: @@ -18,30 +18,29 @@ http_interactions: response: status: code: 400 - message: Bad request + message: Bad Request headers: - Server: - - nginx - Date: - - Sun, 11 Dec 2016 11:49:45 GMT + Cache-Control: + - no-cache Content-Type: - - text/plain - Transfer-Encoding: - - chunked - Connection: - - keep-alive - X-Db-Timeout: - - '120' + - text/plain; charset=utf-8 Pragma: - no-cache - Cache-Control: - - no-cache + X-Db-Timeout: + - '120' + Date: + - Sun, 27 Feb 2022 13:43:33 GMT + Content-Length: + - '105' + X-Dropbox-Response-Origin: + - remote + Server: + - envoy X-Dropbox-Request-Id: - - 285070cc5efd743730eeda72e6db9edd + - f08b61cf3e4e4f59bdd63c6e9c894cb2 body: encoding: UTF-8 string: 'Error in call to API function "files/list_folder/longpoll": request body: cursor: unsupported cursor type' - http_version: - recorded_at: Sun, 11 Dec 2016 11:51:01 GMT -recorded_with: VCR 3.0.1 + recorded_at: Sun, 27 Feb 2022 13:43:33 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/list_folder_longpoll/success.yml b/spec/fixtures/vcr_cassettes/list_folder_longpoll/success.yml index de7511df..1b76f115 100644 --- a/spec/fixtures/vcr_cassettes/list_folder_longpoll/success.yml +++ b/spec/fixtures/vcr_cassettes/list_folder_longpoll/success.yml @@ -5,10 +5,10 @@ http_interactions: uri: https://notify.dropboxapi.com/2/files/list_folder/longpoll body: encoding: UTF-8 - string: '{"timeout":30,"cursor":"AAFToNAroSgzIMkMZsT88-VRF-iVwMmoEBwCreuyqURc4d7ctAOnAEKuHYzaldceDeUgemxXLm5jsKpcT_TBSm0x3yNMW5DALIDlLynBOvxL8E8k2w-EYL1BeJrP6o1ZW-ScH1fN-BDcp3zkPVYFHLySF3rjTSw2rv2U0fAfRl0XJceLVnXTpHxh8vs43EPjJUyZsMOhEm0GuJ5NiNrEob4Rtz3HdTdCoxbZtllD_LtgPoAdP-XNjq_qUtmZj08l6P6NSi2A4Qmum6d3y8DOWjX56-_oySBdXvxo5YgNEzHGHJ8BUbAxT20y3LKH0SWu3-l7s9642B5VvsZhX48Ti8R0tCuLevu27ikAmeYb-dLMRC_uDjSG8-0BBu8I3LdGux7lGOu6ki872kvko6FsKicvvcnOYhpIu3KqzfeSUQiPR-KXWJCT5vHX7dcLbKJUeRYxlQqqPRYGYXutWGcWmrdlNI3jL9_v12pHEpKK4vCWzX4S5T99KdHWVboRXUl5VvQ4qH8UxblbqGvm6NgC6iOm95qDIv-yf8jTRB1qYeWVDOPZT5rFfAXUY26uW7PFwZ2siu_xphvT--52ByxnGuR0TEVhYptdUrC9a3feMeDIygkyTLeH7q-WBCU7eFXiIvCXo1zGMaSFNmpYCnCyhGBqK70k1dR9ftMKo1xlRkIK4gM9pE-MWXVAk6ow1BG6SGtoHq624oNFDBPnOn_CBTdzUO9pvoFXkk3Oe-d6DMkRAXxzv4JUDqRtkyYqLq9cfIRJBExYBUD3nknF9iEAOoymYZad9kpQnmS4Oc2GtD8-mdk2WcV_rPuYd7lHFhYzJ3y0w_wipOHEfKEuBEoaflF7aIpFl3dLx31LuBeW4t5__Cnk4uZnw6fcTZ_P3DGx3q0tL4wPl-cCGz6A1AJIBZROlHPls51Oq45fyStU7AwS7vLfc_NWX-VOMtR5UxiFv7UC3dnaFSdN4Z2FQCW7fmHqCyXu6GKO536jo9tnT0eNqfxSTf7ztOKRjfh1o1euc8poKC-EnDUMYIl-EyJcYQ4XLUhroWpaKM8Us757j3ceIKXPYYqqXi60wFRzBlu_ufqttFG4wtPVqLxPjHAjgCzlDzyiJ7QmAmS2DNxx60Aw2J-fG9oHegLQVCHHE42LGt_uJeogBHMKQI1XF-XbslZ6Wo3PkF_Er8tU7jSue56AbTbCykYl9HR4ZCgdf9jAo7XUvCqrtVCspGV3HLj697wvK_rM-1MImEa9B7RJS3DbNSQ2vvuuoMLEGx5pj8DIreArUYSpyth1P1p2a63o4oka8f7M7peMUyfRRdXA3rLd2O3epvsi4V4PFrGcCeR_DfXwIIFVXmUnP0niL6fpKrfSKRgEO4QZFSTbr03IbSyJMg1FQ2RdKdLhiAREI17glfxLgVcvgbwTWi1RdreAToeOM3Iee3iT6SlMr_h5ASJ8crXVaQyZSYWw_TjsmsA2bCrhhOYhqDkVMrKkImCKWcFmluI5buUYOkazDJrr8n9Z-qx3dE2uhZS12iBkesqgxkk7nJ5Q2WoiCIbyaTJDjxZ69dX3xLq94zSfaHVxeehBTf8PE0W61Cq6b4grdut1QIB3YXrMJBHZU9cEbQyZwzl6Fz-BGtYy-JjCJA8MI-IppDg4kTeg2ot__m_WoeKU4iWyetLZ_UsfX9Y_XLNBpscQbOEjkxrIAFi9uZ0j7kl-Zu5hRkU_50UA3j5WPdpExZjNJcAPAZoey_Wh59wdCLmPeMzJO-Jb286oTj46ZP8FrrW0F8V9mAqZldY5MerQYI7JCK8I0uv5khaFXvFkk1UrMVW8j-17xJB5SoGNFrk6cPJgAtex5FnaefAotZN4DoC1kh595xRakiTNPsYH9vnxQiePHr9gPN4p6FpF1mFcImchjPWwZsLTPBI6E-Fp4KZW3Ll43p7_2-CJXR6lnVihKnOoCsyZ2QWKTtwqVYY82sv7EPHlyHf5KYZEAQMx2I3vZRNhIkYZyr3WjbB7uStRz74HgX2AfGrAXUJ0GrVM-UzNSSmccFjvRqZhHM57QmXAc0aNyb1Gef6a9EE0inSasTlU1jzrJd-ta2SXgqAtl2_uT2ml5lwOn_0EX4TZ_ayWTAA-bPJEOycni3CDezKIIN5HuycZ13aNhO_2v3TPCmXiBuM249AZViKCF5DLhi7cuTFsc_6YqABQGwXgVkXROxWpg6v0v4ZChh3dDKbNLXdmMJfQXDpk0Diy-nmBtKh2vfbeC1SoVMBFT68y7kO8Rrarg5U6yNozZ0a9qIQyQKnhZ1bgO6bQfJ9dz_edvhOSTDlnYJQJsoti-CHeIAhCofQQSL4vtfp_86GVLuiN1ryzwW3C90mM2o97kbPDOCQn-RK1rpagJ0griSWytHnVuuXlY6gWqa3hAP5RmI5VkaG94vEQgmu2TcjJEhUQUAw6KyxAWC499tiCJKk6QvVYVQfkVahltdOrt0OEK29DyGvfOimBkYkjDYTdYrV5Y1O7E_LkX5PxHl6PJnpDvuVbNtGvnnYpc1IfLDwigNY5hCERzRcCWUUl157KwsihrfpTo8q8_-gwryK0ryGs_IRjOf2I1GyPKD1hjiXIAW0PjSzNC1jRz9uvONNS9Jfq5Z1_jo0y_-y3k01IGljf9tya0x7NOzgGNJOPw4dCIAhJPZBCmyMfKJfFuSM-F3cVqHc5zLGYdoCniTcduCb91T0i8E8NgyoXQ_de3fujykMcJNbJAF6ufj_ap6bphDKhQzRadl6Scu5x1DzJEmJ1PENbQn-M5fePCgKebU6CvtNcglzxvYPFItHkONaq-1xFX-WIpFYtnvlPMyYUJu_zPg_RYwOh4h4BlasqtnIEuZukrDbFgu2Ryxa8cuucF0LxMYeHzMbj62OSeuW9dHl6ORFba-R5xfhOhDj8SiHE8ZuFDugvy3Y8gU3vvUiv25xDEgMxoSkp1v3AvxaK1z8sY95ExBC9B-N_HXrG1LEkdbx6FDB3YI3jnJ1n8D9l-WC9KaVu24yDrtezYiAGcCEaerPhu-qpcSsoKygpTFsll58yMhoElzeU0fomEjdx3Bie4zsxy85S-LHlvbuuZ7I6JFTSWIxjrcM7nlbWMP_zXP1DEzvS-PJZA7he9aJ9BnWs6m33uiuoYz9DfNs2JHpbtgfmgB6jnUo7UHeGj02P8Dlkxg"}' + string: '{"timeout":30,"cursor":"AAF2APSHjtbXJqAdZ2Pvpaquig0syveLl4XonPXAZgil94KoBDdJ_RV_JTrndD3akjPZsa5XiX9P_1YaZ_dSH0fyZ6ffoRZk2gJ_gcR8cYhtXr68L_py2WZ-qTx2RBxdvM_AxbChl7DXzS4hbvUOsKyvrWO0q7s0EESd3fbS9R360FgYEOjy8KqwPkPKU3pkZjZ-B-y37sQOFLm3b8cNpC2yx0BxkeUEP4Yja8LXf20741Jm5tZUA12pLGetQyIB-z4xv3kIwCb6d1JPy2I_cZvJ6BQpN85-ryfxMLrh-ieppw"}' headers: User-Agent: - - Faraday v0.9.2 + - Faraday v1.3.0 Content-Type: - application/json Accept-Encoding: @@ -20,27 +20,88 @@ http_interactions: code: 200 message: OK headers: - Server: - - nginx - Date: - - Sun, 11 Dec 2016 11:49:28 GMT + Cache-Control: + - no-cache Content-Type: - application/json - Transfer-Encoding: - - chunked - Connection: - - keep-alive - X-Db-Timeout: - - '120' Pragma: - no-cache + X-Db-Timeout: + - '120' + Date: + - Sun, 27 Feb 2022 13:43:32 GMT + Content-Length: + - '17' + X-Dropbox-Response-Origin: + - remote + Server: + - envoy + X-Dropbox-Request-Id: + - 1a922e27fe7e4cf895bc682de72ce0ab + body: + encoding: UTF-8 + string: '{"changes":true} + + ' + recorded_at: Sun, 27 Feb 2022 13:43:32 GMT +- request: + method: post + uri: https://content.dropboxapi.com/2/files/upload + body: + encoding: UTF-8 + string: Quack! + headers: + Authorization: + - Bearer MOCK_AUTHORIZATION_BEARER + User-Agent: + - Faraday v1.3.0 + Dropbox-Api-Arg: + - '{"path":"/dropbox_api_fixtures/list_folder_longpoll/duck.txt"}' + Content-Type: + - application/octet-stream + Content-Length: + - '6' + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: Cache-Control: - no-cache + X-Content-Type-Options: + - nosniff + X-Server-Response-Time: + - '832' + Content-Type: + - application/json + Accept-Encoding: + - identity,gzip + Date: + - Sun, 27 Feb 2022 13:43:32 GMT + Server: + - envoy + Strict-Transport-Security: + - max-age=31536000; includeSubDomains; preload + X-Robots-Tag: + - noindex, nofollow, noimageindex + Vary: + - Accept-Encoding + X-Dropbox-Response-Origin: + - far_remote X-Dropbox-Request-Id: - - 131006a43b49b73cb0879792691b2df6 + - 4c528e3a2e184c3ab669f13f39dfe53a + Transfer-Encoding: + - chunked body: encoding: ASCII-8BIT - string: '{"changes" : true}' - http_version: - recorded_at: Sun, 11 Dec 2016 11:50:44 GMT -recorded_with: VCR 3.0.1 + string: '{"name": "duck.txt", "path_lower": "/dropbox_api_fixtures/list_folder_longpoll/duck.txt", + "path_display": "/dropbox_api_fixtures/list_folder_longpoll/duck.txt", "id": + "id:L5U1_AOVa-QAAAAAAAA4vA", "client_modified": "2022-02-27T13:43:32Z", "server_modified": + "2022-02-27T13:43:32Z", "rev": "5d9001e2a58b7043720ae", "size": 6, "is_downloadable": + true, "content_hash": "6a2d01bcadbad09a0b0aea75f2e1e0652da80a43c8c196ee0cd29cc268ef73a1"}' + recorded_at: Sun, 27 Feb 2022 13:43:32 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/search/not_found.yml b/spec/fixtures/vcr_cassettes/search/not_found.yml index fd5ba636..49b1a083 100644 --- a/spec/fixtures/vcr_cassettes/search/not_found.yml +++ b/spec/fixtures/vcr_cassettes/search/not_found.yml @@ -2,15 +2,15 @@ http_interactions: - request: method: post - uri: https://api.dropboxapi.com/2/files/search + uri: https://api.dropboxapi.com/2/files/search_v2 body: encoding: UTF-8 - string: '{"start":0,"max_results":100,"mode":"filename","query":"/image.png","path":"/bad_folder"}' + string: '{"query":"/image.png","options":{"path":"/bad_folder"}}' headers: Authorization: - Bearer MOCK_AUTHORIZATION_BEARER User-Agent: - - Faraday v0.9.2 + - Faraday v1.3.0 Content-Type: - application/json Accept-Encoding: @@ -19,25 +19,39 @@ http_interactions: - "*/*" response: status: - code: 409 - message: Conflict + code: 200 + message: OK headers: - Server: - - nginx - Date: - - Sat, 04 Jun 2016 08:36:27 GMT + Cache-Control: + - no-cache + Content-Disposition: + - attachment + Content-Security-Policy: + - sandbox Content-Type: - application/json + Date: + - Sun, 07 Feb 2021 10:30:27 GMT + Pragma: + - no-cache + X-Content-Security-Policy: + - sandbox + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - sameorigin + X-Server-Response-Time: + - '54' + X-Webkit-Csp: + - sandbox Content-Length: - - '96' - Connection: - - keep-alive + - '31' + Server: + - envoy X-Dropbox-Request-Id: - - 8b9426d8c961e5d6d22c78da4d22080e + - a0547acb22a84f57aac28978892f0fb0 body: encoding: UTF-8 - string: '{"error_summary": "path/not_found/..", "error": {".tag": "path", "path": - {".tag": "not_found"}}}' - http_version: - recorded_at: Sat, 04 Jun 2016 08:36:27 GMT -recorded_with: VCR 3.0.1 + string: '{"has_more":false,"matches":[]}' + recorded_at: Sun, 07 Feb 2021 10:30:27 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/search/success.yml b/spec/fixtures/vcr_cassettes/search/success.yml index 28de33f6..53df215c 100644 --- a/spec/fixtures/vcr_cassettes/search/success.yml +++ b/spec/fixtures/vcr_cassettes/search/success.yml @@ -2,15 +2,15 @@ http_interactions: - request: method: post - uri: https://api.dropboxapi.com/2/files/search + uri: https://api.dropboxapi.com/2/files/search_v2 body: encoding: UTF-8 - string: '{"start":0,"max_results":100,"mode":"filename","query":"image.png","path":""}' + string: '{"query":"findable_file"}' headers: Authorization: - Bearer MOCK_AUTHORIZATION_BEARER User-Agent: - - Faraday v0.9.2 + - Faraday v1.3.0 Content-Type: - application/json Accept-Encoding: @@ -22,40 +22,38 @@ http_interactions: code: 200 message: OK headers: - Server: - - nginx - Date: - - Sat, 04 Jun 2016 08:36:26 GMT - Content-Type: - - application/json - Content-Length: - - '346' - Connection: - - keep-alive Cache-Control: - no-cache + Content-Disposition: + - attachment + Content-Security-Policy: + - sandbox + Content-Type: + - application/json + Date: + - Sun, 07 Feb 2021 10:30:26 GMT Pragma: - no-cache - Set-Cookie: - - gvc=NjQ4NjA3NTk0Njg0MzA1MjA3MzgxMDY2NDA0MTQ0MzcxMTAyNjQ%3D; expires=Thu, 03 - Jun 2021 08:36:26 GMT; httponly; Path=/; secure + X-Content-Security-Policy: + - sandbox X-Content-Type-Options: - nosniff - X-Dropbox-Http-Protocol: - - None X-Frame-Options: - - SAMEORIGIN + - sameorigin X-Server-Response-Time: - - '156' + - '160' + X-Webkit-Csp: + - sandbox + Server: + - envoy + Vary: + - Accept-Encoding X-Dropbox-Request-Id: - - 0962978b76ee3f37ca90f918f3ad49b6 + - a0b2671f184943e1916d17d69b4d5ce0 + Transfer-Encoding: + - chunked body: - encoding: UTF-8 - string: '{"matches": [{"match_type": {".tag": "filename"}, "metadata": {".tag": - "file", "name": "image.png", "path_lower": "/image.png", "path_display": "/image.png", - "id": "id:jVVdzRI3CnAAAAAAAAAAAQ", "client_modified": "2016-05-22T09:29:22Z", - "server_modified": "2016-06-04T08:36:02Z", "rev": "1a4524061bdd", "size": - 77019}}], "more": false, "start": 1}' - http_version: - recorded_at: Sat, 04 Jun 2016 08:36:26 GMT -recorded_with: VCR 3.0.1 + encoding: ASCII-8BIT + string: '{"has_more":false,"matches":[{"match_type":{".tag":"filename"},"metadata":{".tag":"metadata","metadata":{".tag":"file","client_modified":"2021-02-07T10:29:47Z","content_hash":"ddc458cb9f13e2e9f4b02a579cc752c8bbcbb7fdfd4c54faea8e98b7f4b80ea8","id":"id:L5U1_AOVa-QAAAAAAAA4sA","is_downloadable":true,"name":"findable_file.txt","path_display":"/dropbox_api_fixtures/search/findable_file.txt","path_lower":"/dropbox_api_fixtures/search/findable_file.txt","rev":"5babc88636b60043720ae","server_modified":"2021-02-07T10:29:48Z","size":4}}}]}' + recorded_at: Sun, 07 Feb 2021 10:30:27 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/search_continue/search.yml b/spec/fixtures/vcr_cassettes/search_continue/search.yml new file mode 100644 index 00000000..6038e1b1 --- /dev/null +++ b/spec/fixtures/vcr_cassettes/search_continue/search.yml @@ -0,0 +1,61 @@ +--- +http_interactions: +- request: + method: post + uri: https://api.dropboxapi.com/2/files/search_v2 + body: + encoding: UTF-8 + string: '{"query":"file","options":{"max_results":1}}' + headers: + Authorization: + - Bearer MOCK_AUTHORIZATION_BEARER + User-Agent: + - Faraday v1.4.1 + Content-Type: + - application/json + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache + Content-Disposition: + - attachment + Content-Security-Policy: + - sandbox + Content-Type: + - application/json + Date: + - Fri, 23 Apr 2021 21:27:36 GMT + Pragma: + - no-cache + X-Content-Security-Policy: + - sandbox + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - sameorigin + X-Server-Response-Time: + - '371' + X-Webkit-Csp: + - sandbox + Server: + - envoy + Vary: + - Accept-Encoding + X-Dropbox-Response-Origin: + - far_remote + X-Dropbox-Request-Id: + - 19d322885ce54309b00e9a851d04a3dc + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"cursor":"ChIKBGZpbGUSAhABIgYIoOC2/yEQAQ==","has_more":true,"matches":[{"match_type":{".tag":"filename"},"metadata":{".tag":"metadata","metadata":{".tag":"folder","id":"id:IrG7JlIiSDcAAAAAAAAARA","name":"create_file_request","path_display":"/dropbox_api_fixtures/create_file_request","path_lower":"/dropbox_api_fixtures/create_file_request"}}}]}' + recorded_at: Fri, 23 Apr 2021 21:27:36 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/fixtures/vcr_cassettes/search_continue/success.yml b/spec/fixtures/vcr_cassettes/search_continue/success.yml new file mode 100644 index 00000000..1ff2c14a --- /dev/null +++ b/spec/fixtures/vcr_cassettes/search_continue/success.yml @@ -0,0 +1,61 @@ +--- +http_interactions: +- request: + method: post + uri: https://api.dropboxapi.com/2/files/search/continue_v2 + body: + encoding: UTF-8 + string: '{"cursor":"ChIKBGZpbGUSAhABIgYIoOC2/yEQAQ=="}' + headers: + Authorization: + - Bearer MOCK_AUTHORIZATION_BEARER + User-Agent: + - Faraday v1.4.1 + Content-Type: + - application/json + Accept-Encoding: + - gzip;q=1.0,deflate;q=0.6,identity;q=0.3 + Accept: + - "*/*" + response: + status: + code: 200 + message: OK + headers: + Cache-Control: + - no-cache + Content-Disposition: + - attachment + Content-Security-Policy: + - sandbox + Content-Type: + - application/json + Date: + - Fri, 23 Apr 2021 21:38:45 GMT + Pragma: + - no-cache + X-Content-Security-Policy: + - sandbox + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - sameorigin + X-Server-Response-Time: + - '212' + X-Webkit-Csp: + - sandbox + Server: + - envoy + Vary: + - Accept-Encoding + X-Dropbox-Response-Origin: + - far_remote + X-Dropbox-Request-Id: + - abfc7c7547b4464792780abcec56091d + Transfer-Encoding: + - chunked + body: + encoding: ASCII-8BIT + string: '{"cursor":"ChIKBGZpbGUSAhABIgYIoOC2/yEQAg==","has_more":true,"matches":[{"match_type":{".tag":"filename"},"metadata":{".tag":"metadata","metadata":{".tag":"file","client_modified":"2021-04-23T21:21:37Z","content_hash":"ddc458cb9f13e2e9f4b02a579cc752c8bbcbb7fdfd4c54faea8e98b7f4b80ea8","id":"id:IrG7JlIiSDcAAAAAAAAAPg","is_downloadable":true,"name":"findable_file.txt","path_display":"/dropbox_api_fixtures/search/findable_file.txt","path_lower":"/dropbox_api_fixtures/search/findable_file.txt","rev":"015c0aa619d60c5000000021fedb020","server_modified":"2021-04-23T21:21:38Z","size":4}}}]}' + recorded_at: Fri, 23 Apr 2021 21:38:45 GMT +recorded_with: VCR 6.0.0 diff --git a/spec/metadata/commit_info_spec.rb b/spec/metadata/commit_info_spec.rb index 1aa877b7..e2119a94 100644 --- a/spec/metadata/commit_info_spec.rb +++ b/spec/metadata/commit_info_spec.rb @@ -1,16 +1,17 @@ +# frozen_string_literal: true describe DropboxApi::Metadata::CommitInfo do - it "can be initialized from a Hash" do + it 'can be initialized from a Hash' do commit_info_hash = { - "path" => "/Homework/math/Matrices.txt", - "mode" => { - ".tag" => "update", - "update" => "a1c10ce0dd78" + 'path' => '/Homework/math/Matrices.txt', + 'mode' => { + '.tag' => 'update', + 'update' => 'a1c10ce0dd78' }, - "autorename" => false, - "mute" => false + 'autorename' => false, + 'mute' => false } commit = described_class.new commit_info_hash - expect(commit.path).to eq("/Homework/math/Matrices.txt") + expect(commit.path).to eq('/Homework/math/Matrices.txt') end end diff --git a/spec/metadata/file_categories_list_spec.rb b/spec/metadata/file_categories_list_spec.rb new file mode 100644 index 00000000..d842138d --- /dev/null +++ b/spec/metadata/file_categories_list_spec.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +context DropboxApi::Metadata::FileCategoriesList do + it 'can be initialized empty' do + list = DropboxApi::Metadata::FileCategoriesList.new([]) + + expect(list).to be_a(Array) + end + + it 'can be initialized with some categories' do + list = DropboxApi::Metadata::FileCategoriesList.new(%w[pdf image]) + + expect(list).to be_a(Array) + expect(list).to include(:pdf) + expect(list).to include(:image) + end + + it 'raises if extensions have an invalid value' do + expect do + DropboxApi::Metadata::FileCategoriesList.new(['game']) + end.to raise_error(ArgumentError) + end +end diff --git a/spec/metadata/file_extensions_list_spec.rb b/spec/metadata/file_extensions_list_spec.rb new file mode 100644 index 00000000..75ad9bec --- /dev/null +++ b/spec/metadata/file_extensions_list_spec.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +context DropboxApi::Metadata::FileExtensionsList do + it 'can be initialized empty' do + list = DropboxApi::Metadata::FileExtensionsList.new([]) + + expect(list).to be_a(Array) + end + + it 'can be initialized with some extensions' do + list = DropboxApi::Metadata::FileExtensionsList.new(%w[jpg png xcf]) + + expect(list).to be_a(Array) + expect(list).to include('jpg') + expect(list).to include('png') + expect(list).to include('xcf') + end + + it 'raises if extensions have an invalid value' do + expect do + DropboxApi::Metadata::FileExtensionsList.new([1, 2, 3]) + end.to raise_error(ArgumentError) + end +end diff --git a/spec/metadata/file_spec.rb b/spec/metadata/file_spec.rb index a468519c..583fdec4 100644 --- a/spec/metadata/file_spec.rb +++ b/spec/metadata/file_spec.rb @@ -1,48 +1,49 @@ +# frozen_string_literal: true context DropboxApi::Metadata::File do def build_file_hash(attrs = {}) { - ".tag" => "file", - "name" => "visrez-video.mp4", - "path_lower" => "/visrez-video.mp4", - "path_display" => "/visrez-video.mp4", - "id" => "id:ARSNw7QJjrAAAAAAAAAAAQ", - "client_modified" => "2016-05-22T09:31:26Z", - "server_modified" => "2016-05-22T09:31:26Z", - "rev" => "2c824061bdd", - "size" => 1136802 + '.tag' => 'file', + 'name' => 'visrez-video.mp4', + 'path_lower' => '/visrez-video.mp4', + 'path_display' => '/visrez-video.mp4', + 'id' => 'id:ARSNw7QJjrAAAAAAAAAAAQ', + 'client_modified' => '2016-05-22T09:31:26Z', + 'server_modified' => '2016-05-22T09:31:26Z', + 'rev' => '2c824061bdd', + 'size' => 1136802 }.merge(attrs) end - it "can be initialized from a hash" do + it 'can be initialized from a hash' do file_hash = build_file_hash file = DropboxApi::Metadata::File.new file_hash expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.name).to eq("visrez-video.mp4") - expect(file.path_lower).to eq("/visrez-video.mp4") - expect(file.path_display).to eq("/visrez-video.mp4") - expect(file.id).to eq("id:ARSNw7QJjrAAAAAAAAAAAQ") + expect(file.name).to eq('visrez-video.mp4') + expect(file.path_lower).to eq('/visrez-video.mp4') + expect(file.path_display).to eq('/visrez-video.mp4') + expect(file.id).to eq('id:ARSNw7QJjrAAAAAAAAAAAQ') expect(file.client_modified).to eq(Time.utc(2016, 5, 22, 9, 31, 26)) expect(file.server_modified).to eq(Time.utc(2016, 5, 22, 9, 31, 26)) - expect(file.rev).to eq("2c824061bdd") + expect(file.rev).to eq('2c824061bdd') expect(file.size).to eq(1136802) end - it "includes the content_hash field" do + it 'includes the content_hash field' do file_hash = build_file_hash({ - "content_hash" => - "2a846fa617c3361fc117e1c5c1e1838c336b6a5cef982c1a2d9bdf68f2f1992a" + 'content_hash' => + '2a846fa617c3361fc117e1c5c1e1838c336b6a5cef982c1a2d9bdf68f2f1992a' }) file = DropboxApi::Metadata::File.new file_hash expect(file).to be_a(DropboxApi::Metadata::File) - expect(file.content_hash).to eq("2a846fa617c3361fc117e1c5c1e1838c336b6a5cef982c1a2d9bdf68f2f1992a") + expect(file.content_hash).to eq('2a846fa617c3361fc117e1c5c1e1838c336b6a5cef982c1a2d9bdf68f2f1992a') end - it "works if metadata is pending" do + it 'works if metadata is pending' do file_hash = build_file_hash({ - "media_info" => { - ".tag" => "pending" + 'media_info' => { + '.tag' => 'pending' } }) @@ -54,21 +55,21 @@ def build_file_hash(attrs = {}) .to eq(:pending) end - context "with photo" do - it "includes the media_info field" do + context 'with photo' do + it 'includes the media_info field' do file_hash = build_file_hash({ - "media_info" => { - ".tag" => "metadata", - "metadata" => { - ".tag" => "photo", - "dimensions" => { - "height" => 700, - "width" => 1050 + 'media_info' => { + '.tag' => 'metadata', + 'metadata' => { + '.tag' => 'photo', + 'dimensions' => { + 'height' => 700, + 'width' => 1050 }, - "time_taken" => "2013-01-10T22:10:13Z", - "location" => { - "latitude" => 10.1234, - "longitude" => 5.1234 + 'time_taken' => '2013-01-10T22:10:13Z', + 'location' => { + 'latitude' => 10.1234, + 'longitude' => 5.1234 } } } @@ -100,19 +101,19 @@ def build_file_hash(attrs = {}) end end - context "with video" do - it "includes the media_info field" do + context 'with video' do + it 'includes the media_info field' do file_hash = build_file_hash({ - "media_info" => { - ".tag" => "metadata", - "metadata" => { - ".tag" => "video", - "dimensions" => { - "height" => 1920, - "width" => 1080 + 'media_info' => { + '.tag' => 'metadata', + 'metadata' => { + '.tag' => 'video', + 'dimensions' => { + 'height' => 1920, + 'width' => 1080 }, - "time_taken" => "2017-07-10T19:54:57Z", - "duration" => 12642 + 'time_taken' => '2017-07-10T19:54:57Z', + 'duration' => 12642 } } }) @@ -139,7 +140,7 @@ def build_file_hash(attrs = {}) end end - it "can be converted back to a hash" do + it 'can be converted back to a hash' do file_hash = build_file_hash file = DropboxApi::Metadata::File.new file_hash @@ -147,7 +148,7 @@ def build_file_hash(attrs = {}) expect(file.to_hash).to eq(file_hash) end - it "works without path data" do + it 'works without path data' do file_hash = build_file_hash.reject { |k, _| %w(path_display path_lower).include?(k) } file = DropboxApi::Metadata::File.new(file_hash) expect(file).to be_a(DropboxApi::Metadata::File) diff --git a/spec/metadata/file_status_spec.rb b/spec/metadata/file_status_spec.rb new file mode 100644 index 00000000..c4cee055 --- /dev/null +++ b/spec/metadata/file_status_spec.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +context DropboxApi::Metadata::FileStatus do + it 'can be initialized from a symbol' do + option = DropboxApi::Metadata::FileStatus.new :active + + expect(option).to eq(:active) + end + + it 'raises if initialized with an invalid value' do + expect do + DropboxApi::Metadata::FileStatus.new :invalid + end.to raise_error(ArgumentError) + end +end diff --git a/spec/metadata/folder_spec.rb b/spec/metadata/folder_spec.rb index b9e89996..9e51c69e 100644 --- a/spec/metadata/folder_spec.rb +++ b/spec/metadata/folder_spec.rb @@ -1,28 +1,29 @@ +# frozen_string_literal: true context DropboxApi::Metadata::Folder do - it "can be initialized from a hash" do + it 'can be initialized from a hash' do folder_hash = { - ".tag" => "folder", - "id" => "id:evvfE6q6cK0AAAAAAAAAS3", - "name" => "Holiday Pictures", - "path_lower" => "/holiday pictures", - "path_display" => "/Holiday Pictures" + '.tag' => 'folder', + 'id' => 'id:evvfE6q6cK0AAAAAAAAAS3', + 'name' => 'Holiday Pictures', + 'path_lower' => '/holiday pictures', + 'path_display' => '/Holiday Pictures' } folder = DropboxApi::Metadata::Folder.new folder_hash expect(folder).to be_a(DropboxApi::Metadata::Folder) - expect(folder.name).to eq("Holiday Pictures") - expect(folder.path_lower).to eq("/holiday pictures") - expect(folder.path_display).to eq("/Holiday Pictures") - expect(folder.id).to eq("id:evvfE6q6cK0AAAAAAAAAS3") + expect(folder.name).to eq('Holiday Pictures') + expect(folder.path_lower).to eq('/holiday pictures') + expect(folder.path_display).to eq('/Holiday Pictures') + expect(folder.id).to eq('id:evvfE6q6cK0AAAAAAAAAS3') end - it "can be converted back to a hash" do + it 'can be converted back to a hash' do folder_hash = { - ".tag" => "folder", - "id" => "id:evvfE6q6cK0AAAAAAAAAS3", - "name" => "Holiday Pictures", - "path_lower" => "/holiday pictures", - "path_display" => "/Holiday Pictures" + '.tag' => 'folder', + 'id' => 'id:evvfE6q6cK0AAAAAAAAAS3', + 'name' => 'Holiday Pictures', + 'path_lower' => '/holiday pictures', + 'path_display' => '/Holiday Pictures' } folder = DropboxApi::Metadata::Folder.new folder_hash diff --git a/spec/metadata/member_action_list_spec.rb b/spec/metadata/member_action_list_spec.rb index ae7faefc..1959cbf1 100644 --- a/spec/metadata/member_action_list_spec.rb +++ b/spec/metadata/member_action_list_spec.rb @@ -1,12 +1,13 @@ +# frozen_string_literal: true context DropboxApi::Metadata::MemberActionList do - it "can be initialized from an empty Array" do + it 'can be initialized from an empty Array' do actions = DropboxApi::Metadata::MemberActionList.new([]) expect(actions).to be_a(DropboxApi::Metadata::MemberActionList) expect(actions.to_a).to eq([]) end - it "can be initialized from a Array of String" do + it 'can be initialized from a Array of String' do strings = %w( remove leave_a_copy @@ -17,7 +18,7 @@ expect(actions.to_a.map(&:to_s)).to eq(strings) end - it "can be initialized from a Array of Symbol" do + it 'can be initialized from a Array of Symbol' do symbols = [ :remove, :leave_a_copy @@ -28,7 +29,7 @@ expect(actions.to_a.map(&:to_sym)).to eq(symbols) end - it "can be initialized from another MemberActionList" do + it 'can be initialized from another MemberActionList' do member_action_list = DropboxApi::Metadata::MemberActionList.new([ :remove, :leave_a_copy @@ -39,7 +40,7 @@ expect(actions).to eq(member_action_list) end - it "can be serialized just as an Array" do + it 'can be serialized just as an Array' do array = [ :remove, :leave_a_copy @@ -49,7 +50,7 @@ .to eq(array.to_json) end - it "will raise an exception if one of the entries is invalid" do + it 'will raise an exception if one of the entries is invalid' do expect { DropboxApi::Metadata::MemberActionList.new [:invalid_action] }.to raise_error ArgumentError diff --git a/spec/metadata/member_permission_spec.rb b/spec/metadata/member_permission_spec.rb index 1bc9c842..32fed24a 100644 --- a/spec/metadata/member_permission_spec.rb +++ b/spec/metadata/member_permission_spec.rb @@ -1,12 +1,13 @@ +# frozen_string_literal: true context DropboxApi::Metadata::MemberPermission do - it "can be initialized from a hash" do + it 'can be initialized from a hash' do hash = { - "action" => { - ".tag" => "remove" + 'action' => { + '.tag' => 'remove' }, - "allow" => false, - "reason" => { - ".tag" => "target_is_self" + 'allow' => false, + 'reason' => { + '.tag' => 'target_is_self' } } diff --git a/spec/metadata/resource_spec.rb b/spec/metadata/resource_spec.rb index be50ebb8..59ee5fe0 100644 --- a/spec/metadata/resource_spec.rb +++ b/spec/metadata/resource_spec.rb @@ -1,16 +1,17 @@ +# frozen_string_literal: true context DropboxApi::Metadata::Resource do - context "with metadata from a file" do - it "initializes a File" do + context 'with metadata from a file' do + it 'initializes a File' do metadata = { - ".tag" => "file", - "name" => "visrez-video.mp4", - "path_lower" => "/visrez-video.mp4", - "path_display" => "/visrez-video.mp4", - "id" => "id:ARSNw7QJjrAAAAAAAAAAAQ", - "client_modified" => "2016-05-22T09:31:26Z", - "server_modified" => "2016-05-22T09:31:26Z", - "rev" => "2c824061bdd", - "size" => 1136802 + '.tag' => 'file', + 'name' => 'visrez-video.mp4', + 'path_lower' => '/visrez-video.mp4', + 'path_display' => '/visrez-video.mp4', + 'id' => 'id:ARSNw7QJjrAAAAAAAAAAAQ', + 'client_modified' => '2016-05-22T09:31:26Z', + 'server_modified' => '2016-05-22T09:31:26Z', + 'rev' => '2c824061bdd', + 'size' => 1136802 } resource = DropboxApi::Metadata::Resource.new metadata @@ -19,14 +20,14 @@ end end - context "with metadata from a folder" do - it "initializes a Folder" do + context 'with metadata from a folder' do + it 'initializes a Folder' do metadata = { - ".tag" => "folder", - "id" => "id:evvfE6q6cK0AAAAAAAAAS3", - "name" => "Holiday Pictures", - "path_lower" => "/holiday pictures", - "path_display" => "/Holiday Pictures" + '.tag' => 'folder', + 'id' => 'id:evvfE6q6cK0AAAAAAAAAS3', + 'name' => 'Holiday Pictures', + 'path_lower' => '/holiday pictures', + 'path_display' => '/Holiday Pictures' } resource = DropboxApi::Metadata::Resource.new metadata diff --git a/spec/metadata/root_info_spec.rb b/spec/metadata/root_info_spec.rb new file mode 100644 index 00000000..83bf3ac5 --- /dev/null +++ b/spec/metadata/root_info_spec.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true +context DropboxApi::Metadata::RootInfo do + it 'can be initialized as a UserRootInfo' do + metadata = { + '.tag' => 'user', + 'root_namespace_id' => '42', + 'home_namespace_id' => '42' + } + + resource = DropboxApi::Metadata::RootInfo.new metadata + + expect(resource).to be_a(DropboxApi::Metadata::UserRootInfo) + end + + it 'can be initialized as a TeamRootInfo' do + metadata = { + '.tag' => 'team', + 'root_namespace_id' => '42', + 'home_namespace_id' => '42', + 'home_path' => '/' + } + + resource = DropboxApi::Metadata::RootInfo.new metadata + + expect(resource).to be_a(DropboxApi::Metadata::TeamRootInfo) + end +end diff --git a/spec/metadata/search_match_field_options_spec.rb b/spec/metadata/search_match_field_options_spec.rb new file mode 100644 index 00000000..198b3f53 --- /dev/null +++ b/spec/metadata/search_match_field_options_spec.rb @@ -0,0 +1,17 @@ +# frozen_string_literal: true + +context DropboxApi::Metadata::SearchMatchFieldOptions do + it 'can be initialized empty' do + options = DropboxApi::Metadata::SearchMatchFieldOptions.new({}) + + expect(options).to be_a(DropboxApi::Metadata::SearchMatchFieldOptions) + expect(options.to_hash).to eq({}) + end + + it 'can be initialized and set to include highlights' do + options = DropboxApi::Metadata::SearchMatchFieldOptions.new({ 'include_highlights' => true }) + + expect(options).to be_a(DropboxApi::Metadata::SearchMatchFieldOptions) + expect(options.include_highlights).to be_truthy + end +end diff --git a/spec/metadata/search_options_spec.rb b/spec/metadata/search_options_spec.rb new file mode 100644 index 00000000..94a2c855 --- /dev/null +++ b/spec/metadata/search_options_spec.rb @@ -0,0 +1,36 @@ +# frozen_string_literal: true + +context DropboxApi::Metadata::SearchOptions do + it 'can be initialized empty' do + options = DropboxApi::Metadata::SearchOptions.new({}) + + expect(options).to be_a(DropboxApi::Metadata::SearchOptions) + expect(options.to_hash).to eq({}) + end + + it 'can be initialized with path' do + options = DropboxApi::Metadata::SearchOptions.new({ 'path' => '/folder' }) + + expect(options).to be_a(DropboxApi::Metadata::SearchOptions) + expect(options.path).to eq('/folder') + end + + it 'can be initialized with several values' do + options = DropboxApi::Metadata::SearchOptions.new( + { + 'path' => '/folder', + 'max_results' => 42, + 'file_status' => :deleted, + 'filename_only' => true, + 'file_extensions' => %w[jpg png], + 'file_categories' => %w[folder paper] + } + ) + + expect(options).to be_a(DropboxApi::Metadata::SearchOptions) + expect(options.path).to eq('/folder') + expect(options.max_results).to eq(42) + expect(options.file_status).to eq(:deleted) + expect(options.filename_only).to eq(true) + end +end diff --git a/spec/metadata/search_order_by_spec.rb b/spec/metadata/search_order_by_spec.rb new file mode 100644 index 00000000..dfda466a --- /dev/null +++ b/spec/metadata/search_order_by_spec.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +context DropboxApi::Metadata::SearchOrderBy do + it 'can be initialized from a symbol' do + option = DropboxApi::Metadata::SearchOrderBy.new :relevance + + expect(option).to eq(:relevance) + end + + it 'raises if initialized with an invalid value' do + expect do + DropboxApi::Metadata::SearchOrderBy.new :invalid + end.to raise_error(ArgumentError) + end +end diff --git a/spec/metadata/shared_link_spec.rb b/spec/metadata/shared_link_spec.rb index ff3e2c32..92f20c9c 100644 --- a/spec/metadata/shared_link_spec.rb +++ b/spec/metadata/shared_link_spec.rb @@ -1,25 +1,26 @@ +# frozen_string_literal: true describe DropboxApi::Metadata::SharedLink do - describe "#to_hash" do - it "works with a string URL" do - url = "http://www.dropbox.com/my/cats/name/s/mittens" + describe '#to_hash' do + it 'works with a string URL' do + url = 'http://www.dropbox.com/my/cats/name/s/mittens' shared_link = described_class.new url expect(shared_link.to_hash) - .to eq({:url => url}) + .to eq({url: url}) end - it "works with a hash URL" do - url = "http://www.dropbox.com/my/cats/name/s/mittens" - shared_link = described_class.new :url => url + it 'works with a hash URL' do + url = 'http://www.dropbox.com/my/cats/name/s/mittens' + shared_link = described_class.new url: url expect(shared_link.to_hash) - .to eq({:url => url}) + .to eq({url: url}) end - it "works with a hash URL and password" do + it 'works with a hash URL and password' do param = { - :url => "http://www.dropbox.com/my/cats/name/s/mittens", - :password => "jibiri" + url: 'http://www.dropbox.com/my/cats/name/s/mittens', + password: 'jibiri' } shared_link = described_class.new param @@ -27,10 +28,10 @@ .to eq(param) end - it "fails with invalid options" do + it 'fails with invalid options' do param = { - :url => "http://www.dropbox.com/my/cats/name/s/mittens", - :jibiri => "jibiri" + url: 'http://www.dropbox.com/my/cats/name/s/mittens', + jibiri: 'jibiri' } expect { diff --git a/spec/metadata/upload_session_cursor_spec.rb b/spec/metadata/upload_session_cursor_spec.rb index dec93500..45be76b6 100644 --- a/spec/metadata/upload_session_cursor_spec.rb +++ b/spec/metadata/upload_session_cursor_spec.rb @@ -1,12 +1,13 @@ +# frozen_string_literal: true describe DropboxApi::Metadata::UploadSessionCursor do - it "can be initialized from a Hash" do + it 'can be initialized from a Hash' do cursor_hash = { - "session_id" => "2c824061bdd", - "offset" => 1136802 + 'session_id' => '2c824061bdd', + 'offset' => 1136802 } cursor = described_class.new cursor_hash - expect(cursor.session_id).to eq("2c824061bdd") + expect(cursor.session_id).to eq('2c824061bdd') expect(cursor.offset).to eq(1136802) end diff --git a/spec/metadata/write_mode_spec.rb b/spec/metadata/write_mode_spec.rb index 467c4422..804c02ff 100644 --- a/spec/metadata/write_mode_spec.rb +++ b/spec/metadata/write_mode_spec.rb @@ -1,34 +1,35 @@ +# frozen_string_literal: true describe DropboxApi::Metadata::WriteMode do - describe "#to_hash" do - it "works with :add as parameter" do + describe '#to_hash' do + it 'works with :add as parameter' do mode = DropboxApi::Metadata::WriteMode.new :add expect(mode.to_hash) - .to eq({".tag" => :add}) + .to eq({'.tag' => :add}) end - it "works with \"add\" as parameter" do - mode = DropboxApi::Metadata::WriteMode.new "add" + it 'works with "add" as parameter' do + mode = DropboxApi::Metadata::WriteMode.new 'add' expect(mode.to_hash) - .to eq({".tag" => :add}) + .to eq({'.tag' => :add}) end - it "works with :overwrite as parameter" do + it 'works with :overwrite as parameter' do mode = DropboxApi::Metadata::WriteMode.new :overwrite expect(mode.to_hash) - .to eq({".tag" => :overwrite}) + .to eq({'.tag' => :overwrite}) end - it "works with :update as parameter" do - mode = DropboxApi::Metadata::WriteMode.new :update, "a1c10ce0dd78" + it 'works with :update as parameter' do + mode = DropboxApi::Metadata::WriteMode.new :update, 'a1c10ce0dd78' expect(mode.to_hash) - .to eq({".tag" => :update, "update" => "a1c10ce0dd78"}) + .to eq({'.tag' => :update, 'update' => 'a1c10ce0dd78'}) end - it "fails with :update without rev" do + it 'fails with :update without rev' do expect { DropboxApi::Metadata::WriteMode.new :update }.to raise_error(ArgumentError) diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 8f7ac228..5936db6e 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,6 +1,7 @@ +# frozen_string_literal: true require 'dropbox_api' require 'support/vcr' require 'tempfile' require File.expand_path('../support/dropbox_scaffold_builder', __FILE__) -ENV["DROPBOX_OAUTH_BEARER"] ||= "MOCK_AUTHORIZATION_BEARER" +ENV['DROPBOX_OAUTH_BEARER'] ||= 'MOCK_AUTHORIZATION_BEARER' diff --git a/spec/support/dropbox_scaffold_builder.rb b/spec/support/dropbox_scaffold_builder.rb index 50520594..7026ec26 100644 --- a/spec/support/dropbox_scaffold_builder.rb +++ b/spec/support/dropbox_scaffold_builder.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true # This class is useful to set up an existing Dropbox account in a state which # is ready to pass the tests. # @@ -20,6 +21,13 @@ # regenerate the cassettes every now and then, but we don't need to do it in # every execution of the test suite. class DropboxScaffoldBuilder + def self.regenerate_all + public_instance_methods + .map(&:to_s) + .select { |method_name| method_name.start_with?('build') } + .each { |method_name| regenerate(method_name.sub('build_', '')) } + end + def self.regenerate(endpoint_name) builder = new(endpoint_name) builder.clobber @@ -34,7 +42,7 @@ def self.fixtures_path File.expand_path('../../fixtures', __FILE__) end - PREFIX = "/dropbox_api_fixtures" + PREFIX = '/dropbox_api_fixtures' def initialize(endpoint_name) @endpoint_name = endpoint_name.to_s @@ -55,16 +63,16 @@ def client end def build_copy_batch - client.upload("#{path_prefix}/regular_file.txt", "Che primo! aon vas?") - client.upload("#{path_prefix}/regular_file_2.txt", "Pal Calvari, amic") + client.upload("#{path_prefix}/regular_file.txt", 'Che primo! aon vas?') + client.upload("#{path_prefix}/regular_file_2.txt", 'Pal Calvari, amic') end def build_create_file_request - client.upload("#{path_prefix}/regular_file.txt", "Arkansas, dude.") + client.upload("#{path_prefix}/regular_file.txt", 'Arkansas, dude.') end def build_delete - file_contents = "Tijuana, amigo." + file_contents = 'Tijuana, amigo.' client.upload "#{path_prefix}/will_be_deleted.txt", file_contents client.upload "#{path_prefix}/wont_be_deleted.txt", file_contents @@ -73,18 +81,22 @@ def build_delete end def build_get_metadata - client.upload("#{path_prefix}/file.txt", "This is a test file.", { - :client_modified => Time.new(1988, 12, 8, 1, 1, 0, "+00:00") + client.upload("#{path_prefix}/file.txt", 'This is a test file.', { + client_modified: Time.new(1988, 12, 8, 1, 1, 0, '+00:00') }) client.create_folder("#{path_prefix}/folder") - client.upload("#{path_prefix}/deleted_file.txt", "This is a test file.") + client.upload("#{path_prefix}/deleted_file.txt", 'This is a test file.') client.delete("#{path_prefix}/deleted_file.txt") end def build_list_folder client.create_folder("#{path_prefix}/shared_folder") client.create_shared_link_with_settings("#{path_prefix}/shared_folder") - client.upload("#{path_prefix}/shared_folder/cow.txt", "Moo.") + client.upload("#{path_prefix}/shared_folder/cow.txt", 'Moo.') + end + + def build_list_folder_longpoll + client.create_folder("#{path_prefix}") end def build_upload @@ -96,7 +108,7 @@ def build_upload_by_chunks end def build_get_thumbnail_batch - file_content = IO.read File.join(self.class.fixtures_path, "img.png") + file_content = IO.read File.join(self.class.fixtures_path, 'img.png') client.upload("#{path_prefix}/img.png", file_content) end @@ -104,10 +116,14 @@ def build_get_shared_link_metadata client.create_folder("#{path_prefix}/shared_folder") client.create_shared_link_with_settings("#{path_prefix}/shared_folder") - client.upload("#{path_prefix}/shared_file.txt", "I shall be shared.") + client.upload("#{path_prefix}/shared_file.txt", 'I shall be shared.') client.create_shared_link_with_settings("#{path_prefix}/shared_file.txt") end + def build_search + client.upload("#{path_prefix}/findable_file.txt", 'Moo.') + end + # We have a prefix for each endpoint to avoid conflicts across them def path_prefix File.join PREFIX, @endpoint_name diff --git a/spec/support/rake_tasks.rb b/spec/support/rake_tasks.rb index 91336e08..cd307dcc 100644 --- a/spec/support/rake_tasks.rb +++ b/spec/support/rake_tasks.rb @@ -1,17 +1,23 @@ +# frozen_string_literal: true require 'dropbox_api' require File.expand_path('../dropbox_scaffold_builder', __FILE__) namespace :test do # Example: `rake test:build_scaffold[get_metadata]` - desc "Regenerates the scaffolding required to test the given endpoint" + desc 'Regenerates the scaffolding required to test the given endpoint' task :build_scaffold, [:endpoint] => [:show_account_warning] do |t, args| - puts "Regenerating #{args[:endpoint].inspect}" - DropboxScaffoldBuilder.regenerate args[:endpoint] + if args[:endpoint].nil? + puts 'Regenerating all' + DropboxScaffoldBuilder.regenerate_all + else + puts "Regenerating #{args[:endpoint].inspect}" + DropboxScaffoldBuilder.regenerate args[:endpoint] + end end task :show_account_warning do - print "NOTE: This task will make changes on a real Dropbox account..." + print 'NOTE: This task will make changes on a real Dropbox account...' sleep 5 - puts " ok, going ahead!" + puts ' ok, going ahead!' end end diff --git a/spec/support/vcr.rb b/spec/support/vcr.rb index fe03771c..5dd6837a 100644 --- a/spec/support/vcr.rb +++ b/spec/support/vcr.rb @@ -1,19 +1,20 @@ +# frozen_string_literal: true require 'vcr' VCR.configure do |config| - config.cassette_library_dir = "spec/fixtures/vcr_cassettes" + config.cassette_library_dir = 'spec/fixtures/vcr_cassettes' config.hook_into :webmock # or :fakeweb headers_matcher = config.default_cassette_options = { - :match_requests_on => [ + match_requests_on: [ :method, :uri, :body, lambda { |a, b| [ - "Authorization", - "Dropbox-Api-Arg" + 'Authorization', + 'Dropbox-Api-Arg' ].all? { |header| a.headers[header] == b.headers[header] } } ] diff --git a/yardoc/endpoint_handler.rb b/yardoc/endpoint_handler.rb index 96d39c32..e12bcdb4 100644 --- a/yardoc/endpoint_handler.rb +++ b/yardoc/endpoint_handler.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module YARD class EndpointHandler < Handlers::Ruby::MethodHandler handles method_call(:add_endpoint) @@ -8,7 +9,7 @@ class EndpointHandler < Handlers::Ruby::MethodHandler CodeObjects::MethodObject.new(namespace, name) do |m| m.parameters = parameters end, - CodeObjects::MethodObject.new(P("DropboxApi::Client"), name) do |m| + CodeObjects::MethodObject.new(P('DropboxApi::Client'), name) do |m| m.parameters = parameters m.group = namespace.namespace.name.downcase end diff --git a/yardoc/helpers/html_helper.rb b/yardoc/helpers/html_helper.rb index 90d149cc..b9d9e91a 100644 --- a/yardoc/helpers/html_helper.rb +++ b/yardoc/helpers/html_helper.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true module YARD module Templates::Helpers module HtmlHelper @@ -15,7 +16,7 @@ def unindent(str) def untab(str, tab_size = 2) tab_space = 2 - str.gsub("\t", " " * tab_space) + str.gsub("\t", ' ' * tab_space) end end end diff --git a/yardoc/rspec.rb b/yardoc/rspec.rb index 6fe3ba8c..cddbaa9d 100644 --- a/yardoc/rspec.rb +++ b/yardoc/rspec.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true YARD::Templates::Engine.register_template_path File.expand_path("#{__FILE__}/../templates") class RSpecDescribeHandler < YARD::Handlers::Ruby::Base @@ -7,11 +8,11 @@ def process objname = statement.parameters.first.jump(:string_content).source if statement.parameters[1] src = statement.parameters[1].jump(:string_content).source - objname += (src[0] == "#" ? "" : "::") + src + objname += (src[0] == '#' ? '' : '::') + src end - obj = {:spec => owner ? (owner[:spec] || "") : ""} + obj = {spec: owner ? (owner[:spec] || '') : ''} obj[:spec] += objname - parse_block(statement.last.last, :owner => obj) + parse_block(statement.last.last, owner: obj) rescue YARD::Handlers::NamespaceMissingError end end @@ -26,10 +27,10 @@ def process obj[:specifications] ||= [] obj[:specifications] << { - :name => statement.parameters.first.jump(:string_content).source, - :file => statement.file, - :line => statement.line, - :source => statement.last.last.source + name: statement.parameters.first.jump(:string_content).source, + file: statement.file, + line: statement.line, + source: statement.last.last.source } end end diff --git a/yardoc/templates/default/method_details/setup.rb b/yardoc/templates/default/method_details/setup.rb index bf84782e..6e2bf18a 100644 --- a/yardoc/templates/default/method_details/setup.rb +++ b/yardoc/templates/default/method_details/setup.rb @@ -1,3 +1,4 @@ +# frozen_string_literal: true def init super sections.last.place(:specs).before(:source)