de.tuberlin.onedrivesdk

Interface OneDriveSDK

public interface OneDriveSDK

This interface provides the functionality of the OneDrive API.

Method Summary

Modifier and Type	Method and Description
void	authenticate(java.lang.String oAuthCode) Used to authorize the session with the OAuth Response Code (used for first authentication)
void	authenticateWithRefreshToken(java.lang.String refreshToken) Used to authorize the session with a RefreshToken
void	disconnect() Disconnect from the current session.
java.util.List<OneDrive>	getAllDrives() Gets all drives of the user.
java.lang.String	getAuthenticationURL() Returns the OneDrive oAuth URL.
OneDrive	getDefaultDrive() Get user's default drive on OneDrive.
OneDrive	getDrive(java.lang.String driveId) Gets drive by the specified drive id.
OneFile	getFileById(java.lang.String id) Gets file by id.
OneFile	getFileByPath(java.lang.String pathToFile) Gets file by path.
OneFile	getFileByPath(java.lang.String pathToFile, OneDrive drive) Gets file by path.
OneFolder	getFolderById(java.lang.String id) Gets folder by id.
OneFolder	getFolderByPath(java.lang.String pathToFolder) Gets folder by path.
OneFolder	getFolderByPath(java.lang.String pathToFolder, OneDrive drive) Gets folder by path.
java.lang.String	getRefreshToken() Returns the RefreshToken of the Current Session, if any exists and the current session is valid.
OneFolder	getRootFolder() Gets the root folder of the default drive.
OneFolder	getRootFolder(OneDrive drive) Gets the root folder of the given dive.
boolean	isAuthenticated() Returns true if the session is authenticated.
void	startSessionAutoRefresh() used to start a thread that request a new authentication token

Method Detail

getDefaultDrive

OneDrive getDefaultDrive()
                  throws java.io.IOException,
                         OneDriveException

Get user's default drive on OneDrive.

Returns:

OneDrive default drive

Throws:

java.io.IOException

java.io.IOException

OneDriveException

getDrive

OneDrive getDrive(java.lang.String driveId)
           throws java.io.IOException,
                  OneDriveException

Gets drive by the specified drive id.

Parameters:

driveId - the drive id

Returns:

OneDrive

Throws:

java.io.IOException

java.io.IOException

OneDriveException

getAllDrives

java.util.List<OneDrive> getAllDrives()
                               throws java.io.IOException,
                                      OneDriveException

Gets all drives of the user.

Returns:

List

Throws:

java.io.IOException

OneDriveException

getRootFolder

OneFolder getRootFolder()
                 throws java.io.IOException,
                        OneDriveException

Gets the root folder of the default drive.

Returns:

root folder

Throws:

java.io.IOException

java.io.IOException

OneDriveException

getRootFolder

OneFolder getRootFolder(OneDrive drive)
                 throws java.io.IOException,
                        OneDriveException

Gets the root folder of the given dive.

Parameters:

drive -

Returns:

root folder

Throws:

java.io.IOException

java.io.IOException

OneDriveException

getFolderById

OneFolder getFolderById(java.lang.String id)
                 throws java.io.IOException,
                        OneDriveException

Gets folder by id.

Parameters:

id -

Returns:

OneFolder

Throws:

java.io.IOException

java.io.IOException

OneDriveException

getFolderByPath

OneFolder getFolderByPath(java.lang.String pathToFolder)
                   throws java.io.IOException,
                          OneDriveException

Gets folder by path.

Parameters:

pathToFolder -

Returns:

OneFolder

Throws:

java.io.IOException

OneDriveException

getFileById

OneFile getFileById(java.lang.String id)
             throws java.io.IOException,
                    OneDriveException

Gets file by id.

Parameters:

id -

Returns:

OneFile

Throws:

java.io.IOException

OneDriveException

getFileByPath

OneFile getFileByPath(java.lang.String pathToFile)
               throws java.io.IOException,
                      OneDriveException

Gets file by path.

Parameters:

pathToFile -

Returns:

OneFile

Throws:

java.io.IOException

OneDriveException

getFolderByPath

OneFolder getFolderByPath(java.lang.String pathToFolder,
                          OneDrive drive)
                   throws java.io.IOException,
                          OneDriveException

Gets folder by path.

Parameters:

pathToFolder -

drive -

Returns:

OneFolder

Throws:

java.io.IOException

OneDriveException

getFileByPath

OneFile getFileByPath(java.lang.String pathToFile,
                      OneDrive drive)
               throws java.io.IOException,
                      OneDriveException

Gets file by path.

Parameters:

pathToFile -

drive -

Returns:

OneFile

Throws:

java.io.IOException

OneDriveException

authenticate

void authenticate(java.lang.String oAuthCode)
           throws java.io.IOException,
                  OneDriveException

Used to authorize the session with the OAuth Response Code (used for first authentication)

Parameters:

oAuthCode - the code from the OneDrive OAuth authentication process.

Throws:

java.io.IOException

OneDriveException

authenticateWithRefreshToken

void authenticateWithRefreshToken(java.lang.String refreshToken)
                           throws java.io.IOException,
                                  OneDriveException

Used to authorize the session with a RefreshToken

Parameters:

refreshToken -

Throws:

java.io.IOException

OneDriveException

getRefreshToken

java.lang.String getRefreshToken()
                          throws OneDriveException

Returns the RefreshToken of the Current Session, if any exists and the current session is valid. A refresh token is only generated if @see OneDriveScope.OFFLINE_ACCESS has been requested for this session. WARNING The RefreshToken is equivalent to a user password and should be stored/encrypted similarly.

Returns:

Throws:

OneDriveException

disconnect

void disconnect()
         throws java.io.IOException

Disconnect from the current session.

Throws:

java.io.IOException

getAuthenticationURL

java.lang.String getAuthenticationURL()

Returns the OneDrive oAuth URL.

Returns:

url

isAuthenticated

boolean isAuthenticated()

Returns true if the session is authenticated.

Returns:

is authenticated

startSessionAutoRefresh

void startSessionAutoRefresh()

used to start a thread that request a new authentication token

See Also:

OneDriveSession.refreshDelay, OneDriveSession.startRefreshThread()