Class: DropboxPopup

DropboxPopup(options, windowOptionsopt, timeout)

The DropboxPopup class is to provide a simple popup window to preform OAuth in.

Constructor

new DropboxPopup(options, windowOptionsopt, timeout)

Parameters:
Name Type Attributes Description
options object
Properties
Name Type Attributes Description
clientId string [Required] The client id for your app.
clientSecret string <optional>
The client secret for your app.
redirectUri string <optional>
[Required] The redirect Uri to return to once auth is complete.
tokenAccessType string <optional>
type of token to request. From the following: legacy - creates one long-lived token with no expiration online - create one short-lived token with an expiration offline - create one short-lived token with an expiration with a refresh token
scope Array.<string> <optional>
scopes to request for the grant
includeGrantedScopes string <optional>
whether or not to include previously granted scopes. From the following: user - include user scopes in the grant team - include team scopes in the grant Note: if this user has never linked the app, include_granted_scopes must be None
usePKCE boolean <optional>
Whether or not to use Sha256 based PKCE. PKCE should be only use on client apps which doesn't call your server. It is less secure than non-PKCE flow but can be used if you are unable to safely retrieve your app secret
windowOptions object <optional>
Properties
Name Type Attributes Description
width number <optional>
The width of the popup window in pixels.
height number <optional>
The height of the popup window in pixels.
top number <optional>
The number of pixels from the top of the screen.
left number <optional>
The number of pixels from the left side of the screen.
additionalParams object <optional>
Any additional parameters desired to be used with the window.open() command. Note, by default, we add the parameters toolbar=no and menubar=no in order to ensure this opens as a popup.
timeout number The timeout for when to give up on the promise and throw an error
Source: