B4A Class Dropbox API V2. All HTTP! All using httputils2

Update April 2017:
Google has changed the ability to use a Webview to get an OAuth-Token. Due to this change it no longer works to get an OAuth-Token using a Webview.
This library is not useable anymore except if you use the Lib only using YOUR token which is hardcoded in your app. This will work.
But if you need to get Access to a Users Dropbox then you can´t use this lib anymore. I suggest to switch to my Java-Wrap for the Drobox Api V2. Here you are able to get an OAuth-Token as this lib does not depend on a Webview.

-----------------------------------------------------------------------------

As you can read here Dropbox has decided to deprecate the Sync and Datastore APIs over the next 12 months. Drobox has now released an new preview site for the new V2 API

Dropbox released an API Explorer for their V2 api.
See the announce too for the explorer.

--------------------------------------------------------------------------------------------------------------------------------------------

This thread is about the HTTP version of the new Dropbox V2 api.
See the documentation here: https://www.dropbox.com/developers-preview/documentation/http#documentation

The attached B4A Library is using this new HTTP Api

The Library is available as Library (jar + xml). Please download DropboxV2_libraryfiles_v091.zip to get the files. Extract the content to your additional Librariespath

Please download DropboxHTTPv2librarysource_V0.91 if you want to change the class. Use this project and compile it to a library to get the correct jar and xml created by yourself
In most cases you dont need this one.

DropboxHttpAPI
Author: DonManfred <msy1912@gmail.com>
Version: 0.93
  • DropBox
    Events:
    • Account (meta As Map)
    • AddFolderMember (meta As Map)
    • Copy (meta As Map)
    • CreateFolder (path_lower As String, name As String)
    • CreateSharedLink (meta As Map)
    • CurrentAccount (meta As Map)
    • Delete (meta As Map)
    • Delta (meta As Map)
    • DownloadLink (meta As Map)
    • FileDownloadFinished (session As Map)
    • FileSearch (result As Map)
    • FileUpload (session As Map)
    • FolderMetadata (meta As Map)
    • GetSharedLinks (meta As Map)
    • GetURLJob (meta As Map)
    • JobStatus (meta As Map)
    • LatestCursor (meta As Map)
    • ListFolder (meta As Map)
    • ListFolders (folders As Map)
    • ListfolderMembers (meta As Map)
    • MetaData (meta As Map)
    • MountFolder (meta As Map)
    • Move (meta As Map)
    • Preview (meta As Map)
    • RelinquishFolderMembership (meta As Map)
    • RemoveFolderMember (meta As Map)
    • Revisions (revs As Map)
    • RevokeSharedLink (meta As Map)
    • SaveURL (meta As Map)
    • ShareFile (meta As Map)
    • ShareFolder (folders As Map)
    • ShareJobStatus (meta As Map)
    • SpaceUsage (meta As Map)
    • Thumbnail (bmp As Bitmap, Tag As Object)
    • TransferFolder (meta As Map)
    • UnmountFolder (meta As Map)
    • UnshareFolder (meta As Map)
    • UpdateFolderMember (meta As Map)
    • UpdateFolderPolicy (meta As Map)
    • UploadSessionFinish (session As Map)
    • UploadSessionStatus (session As Map)
    Methods:
    • IsInitialized As Boolean
      Tests whether the object has been initialized.
    • add_folder_member (shared_folder_id As String, email As String, dropbox_id As String, access_level As String, quiet As Boolean, custom_message As String) As String
      Allows an owner or editor (if the ACL update
      policy allows) of a shared folder to add
      another member.
      For the new member To get access To all the
      functionality For this folder, you will need
      To call mount_folder on their behalf.
      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • check_job_status (async_job_id As String) As String
      Returns the status of an asynchronous job.
      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • check_share_job_status (async_job_id As String) As String
      Returns the status of an asynchronous job for
      sharing a folder.
      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • copy (fromPath As String, toPath As String) As String
      Copy a file or folder to a different location in
      the user's Dropbox.
      If the source path Is a folder all its contents
      will be copied.
    • createfolder (path As String) As String
      Create a folder at a given path.
    • createsharedlink (path As String, shorturl As Boolean) As String
      Create a shared link.
      If a shared link already exists For the given path,
      that link Is returned.

      Note that in the returned PathLinkMetadata, the
      PathLinkMetadata.url field Is the shortened URL
      If CreateSharedLinkArg.short_url argument Is set
      to True.
      Previously, it was technically possible To break
      a shared link by moving Or renaming the corresponding
      File Or folder. In the future, this will no longer
      be the Case, so your app shouldn't rely on this
      behavior. Instead, if your app needs to revoke a
      shared link, use revoke_shared_link.
    • delete (path As String) As String
      Not yet finished....
    • download (path As String, destpath As String, destfile As String) As String
      Download a file from a user's Dropbox.
    • getaccount (accountID As String) As String
      Get information about a user's account.
      The Event
      <code>Example:
      dbx.GetAccount("454365363464")</code>
    • getcurrentaccount As String
      Get information about the current user's account.
      <code>Example:
      dbx.GetCurrentAccount()</code>
    • getdelta (cursor As String, locale As String, includeMediaInfo As Boolean) As String
    • getdownloadlink (path As String) As String
    • getfoldermetadata (SharedFolderID As String, IncludeMembership As Boolean) As String
      Returns shared folder metadata by its folder ID.
      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • getlatestcursor (path As String, recursive As Boolean) As String
      A way to quickly get a cursor for the folder's state.
      Unlike list_folder, list_folder/get_latest_cursor doesn't
      return any entries. This endpoint is for app which only
      needs to know about new files and modifications and doesn't
      need to know about files that already exist in Dropbox.
    • getmetadata (path As String) As String
      Returns the metadata for a file or folder.
    • getpreview (path As String) As String
      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
    • getrevisions (path As String, revlimit As Int) As String
      Return revisions of a file
    • getsharedlinks (path As String) As String
      Returns a list of LinkMetadata objects for this user,
      including collection links.
      If no path Is given Or the path Is empty, returns a
      list of all shared links For the current user,
      including collection links.
      If a non-empty path Is given, returns a list of all
      shared links that allow access To the given path.
      Collection links are never returned in this Case.

      Note that the url field in the response Is never the shortened URL.
    • getsharefilelink (path As String) As String
    • getspaceusage As String
      Get the space usage information for the current user's account.
      <code>Example:
      dbx.GetSpaceUsage()</code>
    • getthumbnail (path As String, format As String, size As String) As String
      Gets a thumbnail for an image.
      Parameters
      format - jpeg (default) Or png.
      For images that are photos, jpeg should be preferred,
      While png Is better For screenshots And digital art.

      size One of the following values (default: s):
      value dimensions (px)
      xs 32x32
      s 64x64
      m 128x128
      l 640x480
      xl 1024x768
    • geturljob (JobID As String) As String
    • getversion As String
    • initialize (CallbackModule As Object, EventName As String, AccessToken As String, debug As Boolean) As String
      Initialize the Dropbox Class.
      Parameters
      CallbackModule
      EventName
      AccessToken
      debug
      <code>Example:
      dbx.GetAccount("454365363464")</code>
    • listfolder (path As String) As String
      Returns the contents of a folder.
    • listfoldercontinue (cursor As String) As String
    • listfoldermembers (SharedFolderID As String) As String
      Returns shared folder membership by its folder ID.
      Warning: This endpoint is in beta and is subject to
      minor but possibly backwards-incompatible changes.
    • listfoldermemberscontinue (cursor As String) As String
    • listfolders As String
    • listfolderscontinue (cursor As String) As String
      Once a cursor has been retrieved from list_folder_members,
      use this to paginate through all shared folder members.

      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • logversioninfo As String
    • mount_folder (SharedFolderID As String) As String
      The current user mounts the designated folder.
      Mount a shared folder For a user after they have
      been added As a member. Once mounted, the shared
      folder will appear in their Dropbox.
      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • move (fromPath As String, toPath As String) As String
      Move a file or folder to a different location in
      the user's Dropbox.
      If the source path Is a folder all its contents
      will be moved.
    • relinquish_folder_membership (SharedFolderID As String) As String
      The current user relinquishes their membership
      in the designated shared folder and will no
      longer have access to the folder. A folder
      owner cannot relinquish membership in their
      own folder.
      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • remove_folder_member (shared_folder_id As String, email As String, dropbox_id As String, leave_a_copy As Boolean) As String
      Allows an owner or editor (if the ACL update policy
      allows) of a shared folder to remove another member.
      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • revokesharedlink (url As String) As String
      Revoke a shared link.
      This API Is only supported For full dropbox apps.
    • saveurl (url As String, destpath As String) As String
    • search (path As String, searchquery As String) As String
      Searches for files and folders.
    • sharefolder (Path As String, MemberPolicy As String, acl_update_policy As String, shared_link_policy As String, forceAsync As Boolean) As String
      Parameters:
      path String
      The path To the folder To share. If it does Not exist, Then a new one Is created.

      member_policy String
      MemberPolicy Who can be a member of this shared folder.
      Policy governing who can be a member of a shared folder.
      Only applicable To folders owned by a user on a team.
      The value will be one of the following datatypes.
      New values may be introduced As our API evolves.

      "team" Only a teammate can become a member.
      "anyone" Anyone can become a member.

      acl_update_policy String
      AclUpdatePolicy Who can add And remove members of this shared folder.
      Policy governing who can change a shared folder's access control
      list (ACL). In other words, who can add, remove, or change the
      privileges of members.The value will be one of the following
      datatypes. New values may be introduced as our API evolves.

      "owner" Only the owner can update the ACL.
      "editors" Any editor can update the ACL.
      This may be further restricted To editors on the same team.

      shared_link_policy String
      The policy To apply To shared links created For
      content inside this shared folder.
      Policy governing who can view shared links.The value
      will be one of the following datatypes. New values
      may be introduced As our API evolves.

      "anyone" Links can be shared with anyone.
      "members" Links can only be shared among
      members of the shared folder.

      force_async Boolean
      Whether To force the share To happen asynchronously.
      The default For this field Is False.
    • transfer_folder (SharedFolderID As String, toDropboxID As String) As String
      Transfer ownership of a shared folder to a
      member of the shared folder.
      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • unmount_folder (SharedFolderID As String) As String
      The current user unmounts the designated folder.
      They can re-mount the folder at a later time using
      mount_folder.
      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • unsharefolder (SharedFolderID As String, leaveacopy As Boolean) As String
      Allows a shared folder owner to unshare the folder.
      You'll need to call check_job_status to determine
      if the action has completed successfully.
      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • update_folder_member (shared_folder_id As String, email As String, dropbox_id As String, access_level As String, quiet As Boolean, custom_message As String) As String
      Allows an owner or editor of a shared folder to
      update another member's permissions.
      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • update_folder_policy (SharedFolderID As String, MemberPolicy As String, acl_update_policy As String, shared_link_policy As String) As String
      Update the sharing policies For a shared folder.
      Warning: This endpoint Is in beta And Is subject To
      minor but possibly backwards-incompatible changes.
    • upload (localpath As String, localFilename As String, dstpath As String, dstfilename As String) As String
      Create a new file with the contents provided
      in the request. Do Not use this To Upload a
      File larger than 150 MB. Instead, create
      an Upload session with UploadSessionStart.
    • uploadsessionstart (sessionMap As Map) As String







First we need to initialize the Class
B4X: 
dbx.Initialize(Me,"DropBox","access_token",True)
If you want to use the class just "with your dropbox" then you can create a access_token in the Dropbox App console.

You can find an example of not using pre-created access_token in Post #45 of this thread.. It is using the OAuth2 Flow to get access to a users Dropbox.

In order they are listed on the Previewdocumentation site i´ll post Examples (or just description on how to) for each of the used endpoints.

B4X: 
dbx.GetAccount("dbid:AAB2cfhttqMg1RjLLRlFzYWWoY6lUpWKsKo")
' Event
Sub DropBox_Account(meta As Map)
    Log("Dropbox_Account: "&meta)
End Sub
Get information about a user's account. In this case it wil get informations about MY (DonManfred) dropboxaccount.

B4X: 
dbx.GetCurrentAccount
' Event
Sub DropBox_CurrentAccount(meta As Map)
    Log("Dropbox_CurrentAccount: "&meta)
End Sub
Get information about the current user's account. It will result in giving YOUR (the developer) account.

B4X: 
dbx.GetSpaceUsage

' Event
Sub DropBox_SpaceUsage(space As Map)
    Log($"DropBox_SpaceUsage(${space})"$)
End Sub
Get the space usage information for the current user's account.


B4X: 
dbx.GetMetadata("/b4arulez.gif")

' Event
Sub DropBox_MetaData(meta As Map)
    Log("Dropbox_MetaData: "&meta)
End Sub
Returns the metadata for a file or folder.



B4X: 
dbx.Listfolder("/Export")
' dbx.ListfolderContinue is called from the result-sub
' automatically if there are more results

' Event
Sub DropBox_ListFolder(meta As Map)
    Log("Dropbox_Listfolder: "&meta)
    Dim cursor As String = meta.Get("cursor")
    Dim has_more As String = meta.Get("has_more")
    Dim entries As List = meta.Get("entries")
    For Each colentries As Map In entries
        Dim path_lower As String = colentries.Get("path_lower")
        Dim name As String = colentries.Get("name")
        filelistfolder.Add(name)

        Dim tag As String = colentries.Get(".tag")
    Next
    If has_more = True Then
        dbx.ListfolderContinue(cursor)
    Else
        Log("No more files")
        Log($"FilesInFolder(${filelistfolder.Size})"$)
        For i = 0 To filelistfolder.Size-1
            LogColor(filelistfolder.Get(i),Colors.Yellow)
        Next
        Dim resulting_files As List = WildCardFilesList(filelistfolder,"*.csv",True,True)
        For i = 0 To resulting_files.Size-1
            LogColor(resulting_files.Get(i),Colors.Green)
        Next

        'kvs.PutObject("filelistfolder", filelistfolder)
    End If

End Sub
Returns the contents of a folder.
NOTE (from Dropbox): We're definitely going to streamline this interface.




B4X: 
dbx.GetLatestCursor("/",False)

' Event
Sub DropBox_LatestCursor(meta As Map)
    Log("DropBox_LatestCursor()")
    Dim cursor As String = meta.Get("cursor")
    longpollcursor = cursor
    kvs.PutSimple("longpollcursor",cursor)
    Log("longpollcursor set: "&cursor)
End Sub
A way to quickly get a cursor for the folder's state. Unlike list_folder, list_folder/get_latest_cursor doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox.






B4X: 
dbx.Download("/9-patch-assets.zip",File.DirDefaultExternal,"9patch.zip")


' Event is missing as yet.
Download a file from a user's Dropbox.
As i´m writing this forumpost i see that this method is missing a event when finished. It is working and saving the file as you can see it in the logs but the event is missing. TODO


B4X: 
    Dim session As Map
    session.Initialize
    session.Put("srcpath","/storage/emulated/0/Download")
    session.Put("srcfile","20150716151904894.pdf")
    session.Put("dstpath","/Export")
    session.Put("dstfile","20150716151904894.pdf")
    session.Put("offset",0)
    session.Put("packetsize",16384)
    dbx.UploadSessionStart(session)
' This is raising multiple events.
Sub DropBox_UploadSessionStatus(session As Map)
    Dim pro As Double = session.Get("offset")/(session.Get("filesize")/100)
    Label1.Text = session.Get("offset")&" / "&session.Get("filesize")&" -> "&pro
End Sub
Sub DropBox_UploadSessionFinish(session As Map)
    Log("DropBox_UploadSessionFinish()")
    Log(session)
End Sub
Start a new upload session. This is used to upload a single file with multiple calls. I´ve tried it with files up to 20mb but should work with 500mb as well.


B4X: 
dbx.Upload(extsdcard,"app-release.apk","/","app-releaseTEST.apk")
' Event
Sub DropBox_FileUpload(meta As Map)
    Log("Dropbox_FileUpload: "&meta)

    Dim path As String = meta.Get("path_lower")
    Log("Path: "&path)
    Dim rev As String = meta.Get("rev")
    Log("Rev: "&rev)
    Dim name As String = meta.Get("name")
    Log("Name: "&name)
    Dim size As Int = meta.Get("size")
    Log("FileSize: "&size)
    Dim client_modified As String = meta.Get("client_modified")
    Dim server_modified As String = meta.Get("server_modified")
    Log("ClientModified: "&client_modified)
    Log("ServerModified: "&server_modified)
End Sub
Create a new file with the contents provided in the request. Should only be used for small files. Maybe up to for example 2mb... It is using ONE httputilscall to transfer the file.


B4X: 
dbx.Search("","libmysql")
' Event
Sub DropBox_FileSearch(meta As Map)
    Log("Dropbox_FileSearch: "&meta)
End Sub
Searches for files and folders in your dropbox.



B4X: 
dbx.CreateFolder("/Export")
' Event
Sub DropBox_Createfolder(path As String,filename As String)
    Log($"DropBox_Createfolder(${path},${filename})"$)
End Sub
Create a folder at a given path.
No file or folder may exist at the path. The parent folder will be created if it does not already exist (and so on). If the parent exists it must be a folder (and the same for any ancestor). If an ancestor is a shared folder it must have write access.

B4X: 
dbx.delete(("/9-patch-assets.zip")
' Event
Delete the file or folder at a given path.
If the path is a folder all its contents will be deleted too.


B4X: 
    ' Copy a FILE
    ' Source and Destination should point to a file
    'dbx.copy("/Export/b4arulez.gif","/copyofb4arulez.gif")

    ' Copy a FOLDER
    'dbx.copy("/Export","/copyfoldertest")
    ' will resulting in creating a folder copyfoldertest
    ' and then all files from Export will be copied to copyfoldertest/

' Event
Sub Dropbox_copy(copyinfo As Map)
    Log($"DropBox_copy(${copyinfo})"$)
End Sub

If the path is a folder all its contents will be deleted too.


B4X: 
    ' Move  a FILE
    ' Move a FILE
    'dbx.move("/copyofb4arulez.gif","/newnameofb4arulez.gif")

    ' Move a FOLDER
    dbx.move("/copyfoldertest","/newdestfoldertest")

' Event
Sub Dropbox_move(moveinfo As Map)
    Log($"DropBox_copy(${moveinfo})"$)
End Sub


This method is NOT FINISHED as yet. DON´T USE it actually. TODO

B4X: 
  dbx.GetThumbnail("/2000likes.png","png","s")
   'Parameters
   'format jpeg (default) Or png. For images that are photos,
   ' jpeg should be preferred, While png Is better For screenshots And digital art.
  '
  ' size One of the following values (default: s):
  'value   dimensions (px)
  ' xs     32x32
  ' s       64x64
  ' m       128x128
  ' l       640x480
  ' xl     1024x768

' Event
Sub Dropbox_Thumbnail(thumb As Bitmap, Tag As Object)
   Log($"DropBox_Thumbnail(${Tag})"$)
   iv1.Bitmap = thumb
End Sub
Get a thumbnail for an image.


B4X: 
dbx.GetRevisions("/B4A/LibMySQL/MySQLExample.zip",100)
' Event
Sub DropBox_Revisions(revlist As Map)
   Log("DropBox_Revisions()")
   Log(revlist)
   Dim is_deleted As String = revlist.Get("is_deleted")
   Dim entries As List = revlist.Get("entries")
   For Each colentries As Map In entries
     Dim path As String = colentries.Get("path_lower")
     Dim revision As String = colentries.Get("rev")
     Dim name As String = colentries.Get("name")
     Dim client_modified As String = colentries.Get("client_modified")
     Dim size As Int = colentries.Get("size")
     Dim server_modified As String = colentries.Get("server_modified")
     Log($"FileRev(${path}):${revision}->${size} "$)
   Next


   'kvs.PutSimple("longpollcursor",cursor)
End Sub
Return revisions of a file

Update:: August, 20th, 2017
If you want to use Dropbox to connect to the USERS Dropbox (not YOURS) then you should look at the DropboxV2-OAuth2.zip example. It shows the way on how to get an Axccesstoken using the V2 endpoints.


The following methods are missing totally as yet: TODO

- Restore

TODO:

-

Dependencies:
- httputils2 (okHTTP)
- JSON
- RandomAcessFile
- KeyValueStore (used in example but not really needed by the class or Library)


This Class is open source and free to used and extended by anyone!

If you want to donate for my work building the class you can do it here:
 

Attachments

  • DropboxV2_version0.80.zip
    17.5 KB · Views: 639
  • DropboxV2_version0.85.zip
    17.7 KB · Views: 790
  • DropboxV2_libraryfiles_v093.zip
    19.6 KB · Views: 1,039
  • DropboxHTTPv2librarysource_V0.93.zip
    17.5 KB · Views: 919
  • DropboxV2-OAuth2.zip
    72.9 KB · Views: 662
Last edited:
Click to expand...
wizard699

wizard699

Active Member
Licensed User
Longtime User
DonManfred said:
B4X: 
Sub Globals
    'These global variables will be redeclared each time the activity is created.
    'These variables can only be accessed from this module.
    Dim dbx As DropBox
End Sub
Sub Activity_Create(FirstTime As Boolean)
    dbx.Initialize(Me,"DropBox","your key here",True)
    dbx.Upload(File.DirRootExternal,"overlay.png","/","overlay.png")
End Sub
Sub DropBox_FileUpload(meta As Map)
    Log("Dropbox_FileUpload: "&meta)
 
    Dim Path As String = meta.Get("path_lower")
    Log("Path: "&Path)
    Dim rev As String = meta.Get("rev")
    Log("Rev: "&rev)
    Dim name As String = meta.Get("name")
    Log("Name: "&name)
    Dim size As Int = meta.Get("size")
    Log("FileSize: "&size)
    Dim client_modified As String = meta.Get("client_modified")
    Dim server_modified As String = meta.Get("server_modified")
    Log("ClientModified: "&client_modified)
    Log("ServerModified: "&server_modified)
End Sub
Click to expand...

Yes DonManfred I'm sure that in last version work perfectly.
I'll be waiting last version.
 
DonManfred

DonManfred

Expert
Licensed User
Longtime User
mr23

mr23

Active Member
Licensed User
Longtime User
DonManfred said:
    • initialize (CallbackModule As Object, EventName As String, AccessToken As String, debug As Boolean) As String
      Initialize the Dropbox Class.
      Parameters
      CallbackModule
      EventName
      AccessToken
      debug
      <code>Example:
      dbx.GetAccount("454365363464")</code>
...

First we need to initialize the Class
B4X: 
dbx.Initialize(Me,"DropBox","secretkey",True)
Click to expand...

Don, the 'AccessToken' is shown Initialize API, but example shows 'secretkey'. The latter didn't work, but a generated access token, for testing only, does work.

https://www.dropbox.com/developers/reference/oauth-guide requires using OAuth2.

Does this API (or will it, in the future) provide a method to go through the OAuth2 flow? Maybe I missed it.
 
DonManfred

DonManfred

Expert
Licensed User
Longtime User
mr23 said:
Does this API (or will it, in the future) provide a method to go through the OAuth2 flow? Maybe I missed it.
Click to expand...
There is no such endpoint in the V2 Api as yet. Maybe they will provide one in future. If they do i´ll extend my class to the new endpoints.

For now there is no such method in the Api. and due to this it is not part of my Class.

But you can surely extends the class (source is in post #1) with some API V1 calls which will do such Requests and then replace the secret key with the new auth-token
 
DonManfred

DonManfred

Expert
Licensed User
Longtime User
UPDATE: Please note that the code here is for Authenticating against the V1 api.

Do not use this example anymore.

mr23 said:
Does this API (or will it, in the future) provide a method to go through the OAuth2 flow?
Click to expand...
If you want to use "the users" Dropbox token (or even to get the token through the OAuth2-flow) you can use this

This is an simple Example providing a activity with a webview to do the tokenrequest.
B4X: 
Sub Process_Globals
    Dim dbx As DropBox
    Dim clientID As String
    Dim accesstoken As String
End Sub
Sub Activity_Create(FirstTime As Boolean)
    If FirstTime = True Then
        clientID = "8bgblt25ldqwh70" ' Put your ClientID of your app here
        accesstoken = "" ' define an empty token
    End If
    Activity.LoadLayout("LayoutMain")

    dbx.Initialize(Me,"DropBox","",True) ' Note that in initialization of DropboxClass the token is set to an empty string.


Sub SetDropboxToken(token As String)
    dbx.AccessToken = accesstoken
    dbx.ListFolders()
End Sub

Additional there is a new Activity in the example
B4X: 
Sub Globals
    'These global variables will be redeclared each time the activity is created.
    'These variables can only be accessed from this module.

    Private www As WebView
End Sub

Sub Activity_Create(FirstTime As Boolean)
    'Do not forget to load the layout file created with the visual designer. For example:
    Activity.LoadLayout("OAuth")
    'Main.dbx.request_auth
End Sub

Sub Activity_Resume
    www.LoadUrl("https://www.dropbox.com/1/oauth2/authorize?client_id="&Main.clientID&"&response_type=token&redirect_uri=http://127.0.0.1/")

End Sub

Sub Activity_Pause (UserClosed As Boolean)

End Sub


Sub www_PageFinished (Url As String)
    Log($"www_PageFinished(${Url})"$)
    ' http://127.0.0.1/#access_token=ToZD0ArtpcUAAAAAAADb-4YF3VNuCQNZz_DK5B2cTcKI0qQAZBIU3z-EdizUT2bP&token_type=bearer&uid=189761154

End Sub

Sub www_OverrideUrl (Url As String) As Boolean
    Log($"www_OverrideUrl(${Url})"$)
    If Url.Contains("access_token=") Then
        ' Access Token available... Cut them off the url
        Dim token As String = Url.SubString2(Url.IndexOf("access_token=")+13,Url.IndexOf("&"))
        Log("Token found... Setting global var")
        Main.accesstoken = token
        Log($"Token "${token}" is set... Finishing activity now..."$)
        'Log(token)
        CallSubDelayed2(Main,"SetDropboxToken",token)
        Activity.Finish
        Return False
    End If

End Sub

Additional info:
B4X: 
dbx.Initialize(Me,"DropBox","",True) ' Note that in initialization of DropboxClass the token is set to an empty string.
Note that you are not allowed to do any DropboxMethodCall unless you go through the OAuth-Flow (in this example start the OAuth activity) as they will not work due to the missing access_token!!


Edit:
Replaced the Example with a new whichis now Authenticating against the V2 api.

 

Attachments

  • DropboxV2-OAuth2.zip
    72.9 KB · Views: 343
Last edited:
Esteve

Esteve

Member
Licensed User
Hello, I am a newbie in B4A, few days ago I bought the license.
I'd like to handle errors initialize dbx.
Is there an event that occured if, for example,"access_token" fails?

Thanks!
Sorry for my English...
 
DonManfred

DonManfred

Expert
Licensed User
Longtime User
Esteve said:
Hello, I am a newbie in B4A, few days ago I bought the license.
Click to expand...
Good decision :)

Welcome in the community!

Esteve said:
Is there an event that occured if, for example,"access_token" fails?
Click to expand...
You did not make any Dropbox-Call when initializing the class. So, there could not be any error...

But you will get an error when calling one of the methods if the token is wrong i guess.
 
Esteve

Esteve

Member
Licensed User
Thanks!!

OK, what happens is that when I call the method dbx.getcurrentaccount with a invalid acces token, I receive a log of the error but the event is not activated, then not be how to capture this error.:(
 
Reinierus

Reinierus

Member
Licensed User
Longtime User
Hello DonManfred.
I am trying to use the example, but there is a library that I don't have and don't see in the dependencies.
This is one of the lines with the error:

B4X: 
job.GetRequest.SetContentEncoding("text/plain")

upload_2016-2-18_12-25-45.png


What am I doing wrong?

Thanks a lot
 
incendio

incendio

Well-Known Member
Licensed User
Longtime User
Great library !!
Thanks for your contribution.

I have a fews question :
1) when generate token in Dropbox developer, I saw App key & App secret, is there any use for this?

2) I have these codes
B4X: 
    dbx.CreateFolder("/f2")
dbx.Upload(PUB_InstDir,"reports.png","/f2","rp5.png")
dbx.Upload(PUB_InstDir,"purchase.png","/f2","p5.png")
Folder created without checking if folder already exist. When folder does exist, JobDone raised an error "path/conflict/folder", but upload operation still OK.
Is it OK to ignore this message?
 
DonManfred

DonManfred

Expert
Licensed User
Longtime User
incendio said:
when generate token in Dropbox developer, I saw App key & App secret, is there any use for this?
Click to expand...
You can directly use it in your app when initialization of th class.
If you use this tokens the class will directly and only work with YOUR dropbox then.
incendio said:
Is it OK to ignore this message?
Click to expand...
From principle, yes.
But to be safer you should test the existence of a folder first (list files/directories) and only call this command if the foder do not exist.
 
incendio

incendio

Well-Known Member
Licensed User
Longtime User
Thanks for your replay.

If I want to use user dropbox token (post #45), where do i get client id?
 
DonManfred

DonManfred

Expert
Licensed User
Longtime User
incendio said:
If I want to use user dropbox token (post #45), where do i get client id?
Click to expand...
You use your clientID in initialization of the class. The APP is the client. Using the users token it will work with the users Dropbox.
Using your token (not using the OAuth way) it will use your dropbox.
 
incendio

incendio

Well-Known Member
Licensed User
Longtime User
DonManfred said:
You use your clientID in initialization of the class. The APP is the client. Using the users token it will work with the users Dropbox.
Using your token (not using the OAuth way) it will use your dropbox.
Click to expand...
Sorry, I don't understand.

I want to use users token/using the OAuth way, how to get clientId?
 
DonManfred

DonManfred

Expert
Licensed User
Longtime User
incendio said:
how to get clientId?
Click to expand...

You dont need. The App needs the ClientID (your client-ID found in your Developerconsole at Dropbox).

The token itself is used to allow access to a specific Dropbox. In your case the Dropbox of your Customer. But you dont need a Client-ID of your Customer.
If you write the app for a customer. Then maybe he need to give you the Client-ID from his Developerconsole so you can use this Client-ID in your app then...
 
incendio

incendio

Well-Known Member
Licensed User
Longtime User
DonManfred said:
You dont need. The App needs the ClientID (your client-ID found in your Developerconsole at Dropbox).

The token itself is used to allow access to a specific Dropbox. In your case the Dropbox of your Customer. But you dont need a Client-ID of your Customer.
If you write the app for a customer. Then maybe he need to give you the Client-ID from his Developerconsole so you can use this Client-ID in your app then...
Click to expand...
If not mistaken, in this case, application published in play store can't directly backup and restore to user's Dropbox since application don't know client id, is that right?

Btw, just found that client id is an app key in developers console.
 
Last edited:
DonManfred

DonManfred

Expert
Licensed User
Longtime User
incendio said:
can't directly backup and restore to user's Dropbox since application don't know client id
Click to expand...
Can´t directly backup or restore cause the app has no Token at this time. The app-user need togo through the OAuth-Flow to let the app get a token to work with. Yes.
incendio said:
Btw, just found that client id is an app key in developers console.
Click to expand...
That´s what i said. The APP uses the Client-ID
 
DonManfred

DonManfred

Expert
Licensed User
Longtime User
You can ask the app-user for client-ID and maybe the token. (Two editfields)
The user enters the data and your app the reinitialize with the entered client and token.
This way you dont need to let the user go over the OAuth-Flow to get an token.
You app can store the entered data in sqlite-db or so. And on App-start you read the credentials and use them in Initialize. So. doing this allows you then to directly work with the users dropbox
 
incendio

incendio

Well-Known Member
Licensed User
Longtime User
DonManfred said:
You can ask the app-user for client-ID and maybe the token. (Two editfields)
The user enters the data and your app the reinitialize with the entered client and token.
This way you dont need to let the user go over the OAuth-Flow to get an token.
You app can store the entered data in sqlite-db or so. And on App-start you read the credentials and use them in Initialize. So. doing this allows you then to directly work with the users dropbox
Click to expand...
This method required users to create Dropbox's app, i am afraid not all users know how to do this.
Is there no other methods? I was thinking if it's possible, users only input their Dropbox's account & password, with this info, application can do backup & restore operations.
 
You must log in or register to reply here.

Similar Threads

B
  • Solved
Android Question Dropbox download not working
Replies
6
Views
2K
Brad Henderson
B
NGUYEN TUAN ANH
  • Question
Android Question DropboxV2 library cannot run dbxFiles_DownloadFinished
Replies
6
Views
1K
DonManfred
DonManfred
J
  • Question
Android Question Gmail API, not working
Replies
4
Views
2K
Jeremy Tipton
J
J
  • Question
Android Question Dropbox API V2. All HTTP! All using httputils2
Replies
3
Views
767
DonManfred
DonManfred
F
  • Question
Android Question Can't connect to my DropBox app
Replies
5
Views
4K
Fab117
F
Top