Module TeamDriveApi :: Class TeamDriveApi

Class TeamDriveApi

InternalTeamDriveApi --+
                       |
                      TeamDriveApi

Instance Methods
dict
getSpaceByName(self, spaceName)
Returns a Space by a given Space name.
dict
getAddressbookByName(self, addressName)
Returns an Addressbook by a given name.
TeamDriveApi
__init__(self, server='[::1]:45454')
Creates a new instance of the API. (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
about(self)
Returns information about the application. (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
createSpace(self, spaceName, disableFileSystem)
Creates a new Space. (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
deleteSpace(self, spaceId, delInFs, delOnServer)
Deletes a Space. (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
getAddressbook(self, addressId)
Returns information about a given Addressbook Id. (Inherited from TeamDriveApi.InternalTeamDriveApi)
list[int]
getAddressbookIds(self)
Returns all knows Addressbook Ids. (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
getFile(self, fileId)
Returns information about the given File Id (Inherited from TeamDriveApi.InternalTeamDriveApi)
list[dict]
getFiles(self, spaceId, filePath, trashed)
Returns a list of files matching the Space Id, the file path and the trashed flag. (Inherited from TeamDriveApi.InternalTeamDriveApi)
list[int]
getFolderContent(self, spaceId, filePath, trashed)
Returns a list of file Ids in the Space in a folder. (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
getLoginInformation(self)
Returns information about the current user (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
getSpace(self, spaceId)
Will return information about that Space. (Inherited from TeamDriveApi.InternalTeamDriveApi)
list[int]
getSpaceIds(self)
Returns a list of all known Spaces Ids. (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
inviteMember(self, spaceId, addressId, text)
Invites a user into a Space. (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
joinSpace(self, spaceId, disableFileSystem, spacePath=None)
Joins an archived Space or rejoins an existing. (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
login(self, username, password)
Will login a user with a given password. (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
moveFile(self, spaceId, filePath, trashed, newFilePath)
Moves a file from filePath to newFilePath in the given Space. (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
putFile(self, spaceId, path, data)
Uploads a file into a Space. (Inherited from TeamDriveApi.InternalTeamDriveApi)
dict
quit(self, logout)
Quits TeamDrive. (Inherited from TeamDriveApi.InternalTeamDriveApi)
Method Details

getSpaceByName(self, spaceName)

 

Returns a Space by a given Space name. Throws a TeamDriveException, if there is no Space with this name.

Parameters:
  • spaceName (str) - The Name.
Returns: dict
Raises:
  • httplib.HTTPException - a Connection Error.

getAddressbookByName(self, addressName)

 

Returns an Addressbook by a given name. Throws a TeamDriveException, if there is no Space with this name.

Parameters:
  • addressName (str) - The Name.
Returns: dict
Raises:
  • httplib.HTTPException - a Connection Error.