public class

GetAccountTreeMethod

extends BaseBoxMethod
java.lang.Object
   ↳ cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.BaseBoxMethod
     ↳ cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.GetAccountTreeMethod

Summary

Constants
String PARAMS_KEY_NOZIP this parameter decides whether show files or not.
String PARAMS_KEY_ONELEVEL this parameter indicates if we only show one level of our file structure.
[Expand]
Inherited Fields
From class cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.BaseBoxMethod
Public Constructors
GetAccountTreeMethod()
Public Methods
GetAccountTreeResponse getAccountTree(GetAccountTreeRequest getAccountTreeRequest)
This method is used to get a user's files and folders tree.
[Expand]
Inherited Methods
From class cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.BaseBoxMethod
From class java.lang.Object

Constants

public static final String PARAMS_KEY_NOZIP

this parameter decides whether show files or not. public static final String PARAMS_KEY_NOFILES = "nofiles"; /** this parameter decides whether zip the content with base64 encoding.

Constant Value: "nozip"

public static final String PARAMS_KEY_ONELEVEL

this parameter indicates if we only show one level of our file structure.

Constant Value: "onelevel"

Public Constructors

public GetAccountTreeMethod ()

Public Methods

public GetAccountTreeResponse getAccountTree (GetAccountTreeRequest getAccountTreeRequest)

This method is used to get a user's files and folders tree. 'folder_id' param defines root folder from which the tree begins. 'params' is array of string where you can set additional parameters, which are: onelevel - make a tree of one level depth, so you will get only files and folders stored in folder which folder_id you have provided. nofiles - include folders only in result tree, no files. nozip - do not zip tree xml. On successful result you will receive 'listing_ok' as status and base64 encoded zipped tree xml. So you have to decode the received tree, then unzip it (if you haven't set 'nozip' param) and you will get xml like this: (note that updatedand createdare UNIX timestamps in PST).

Parameters
getAccountTreeRequest Request
Returns
  • response
Throws
IOException IO exception
BoxException box exception