%MFT.Kiteworks
Class %MFT.Kiteworks Extends %MFT.API [ System = 4 ]
The %MFT.Kiteworks class is the subclass of %MFT.API which implements the APIs using Accellion Kiteworks.
Methods
GetRequestId
ClassMethod GetRequestId(connection As %SYS.MFT.Connection.Kiteworks, itemInfo As %MFT.ItemInfo) As %String
Get the form of id for a file or folder that is most efficient for subsequent calls. GetRequestId will return either an id of the form "id:" or a full path depending on which is more efficient. This method is included to allow the id for future requests to be saved in the most efficient form.
GetFolderInfo
ClassMethod GetFolderInfo(connection As %SYS.MFT.Connection.Kiteworks, path As %String, Output itemInfo As %MFT.ItemInfo) As %Status
Return the item info object which describes the specified folder. path may be a folder path. path may also be specified as an id of the form "id:" which was obtained from a %MFT.ItemInfo object. "" May be used as the path to specify the current folder. If a folder does not exist at the specified path, then $$$OK is returned as status and itemInfo is returned as "".
GetItemInfo
ClassMethod GetItemInfo(connection As %SYS.MFT.Connection.Kiteworks, itemPath As %String, Output itemInfo As %MFT.ItemInfo) As %Status [ Internal ]
Internal method to return the item info object which describes the specified file or folder. "" May be used as the itemPath to specify the current folder.
If an item does not exist at the specified path, then $$$OK is returned as status and itemInfo is returned as "".
%MFT.Dropbox only supports the file's owner getting information about a file.
GetEntry
ClassMethod GetEntry(entries As %DynamicArray, Output entry As %DynamicObject) As %Integer [ Internal ]
Remove deleted items from array
CreateItemInfo
ClassMethod CreateItemInfo(response As %DynamicObject, containerPath As %String = "") As %MFT.ItemInfo [ Internal ]
Create an ItemInfo object from a Kiteworks response
GetUsername
ClassMethod GetUsername(connection As %SYS.MFT.Connection.Kiteworks, internalId As %String, Output username As %String) As %Status
Get the external username that corresponds to the specified internal user id.
DeleteFolder
ClassMethod DeleteFolder(connection As %SYS.MFT.Connection.Kiteworks, path As %String, permanent As %Boolean = 0) As %Status
Delete the remote folder. path may be a folder path. path may also be specified as an id of the form "id:" which was obtained from a %MFT.ItemInfo object. If permanent is true, then the folder will be permanently deleted. Otherwise the folder will be moved to trash.
If the remote folder does not exist at the specified path, then $$$OK is returned as status and itemInfo is returned as "".
CreateFolder
ClassMethod CreateFolder(connection As %SYS.MFT.Connection.Kiteworks, folderPath As %String, Output itemInfo As %MFT.ItemInfo) As %Status
Creates the remote folder at the specified folderPath. Each level of the folder path should be created separately if it does not already exist. An %MFT.ItemInfo object is returned for the new folder.
GetFolderContents
ClassMethod GetFolderContents(connection As %SYS.MFT.Connection.Kiteworks, folderPath As %String, recursive As %Boolean = 0, Output folderContents As %MFT.FolderContents) As %Status
Return the folder contents object for the specified folder. folderPath may be a folder path. folderPath may also be specified as an id of the form "id:" which was obtained from a %MFT.ItemInfo object. "" May be used as the folderPath to specify the current folder. The FolderContents object will include a list of %MFT.ItemInfo objects which contain a file or folder name and some additional simple information.
GetFolderContentsInternal
ClassMethod GetFolderContentsInternal(connection As %SYS.MFT.Connection.Kiteworks, folderId As %String, path As %String, recursive As %Boolean = 0, folderContents As %MFT.FolderContents) As %Status [ Internal ]
Internal method for recursing over subfolders to return the folder contents object for the specified folder.
GetFileInfo
ClassMethod GetFileInfo(connection As %SYS.MFT.Connection.Kiteworks, path As %String, Output itemInfo As %MFT.ItemInfo) As %Status
Return the item info object which describes the specified file. path may be a file path. path may also be specified as an id of the form "id:" which was obtained from a %MFT.ItemInfo object. If a file does not exist at the specified path, then $$$OK is returned as status and itemInfo is returned as "".
DeleteFile
ClassMethod DeleteFile(connection As %SYS.MFT.Connection.Kiteworks, path As %String, permanent As %Boolean = 0) As %Status
Delete the remote file. path may be a file path. path may also be specified as an id of the form "id:" which was obtained from a %MFT.ItemInfo object.
If permanent is true, then the file will be permanently deleted. Otherwise the file will be moved to trash.
If the remote file does not exist at the specified path, then $$$OK is returned as status and itemInfo is returned as "".
UploadFile
ClassMethod UploadFile(connection As %SYS.MFT.Connection.Kiteworks, localFilePath As %String, filePath As %String, replace As %Boolean = 0, Output itemInfo As %MFT.ItemInfo) As %Status
Update the specified remote file with the contents of the specified local file. filePath must be a file path. An id may not be specified. If replace is true, then an existing file of the same name will be replaced. The default is to return an error if a replacement is attempted.
UploadStream
ClassMethod UploadStream(connection As %SYS.MFT.Connection.Kiteworks, stream As %BinaryStream, filePath As %String, replace As %Boolean = 0, Output itemInfo As %MFT.ItemInfo) As %Status
Update the specified remote file with the contents of the specified stream. filePath must be a file path. An id may not be specified. If replace is true, then an existing file of the same name will be replaced. The default is to return an error if a replacement is attempted.
DownloadFile
ClassMethod DownloadFile(connection As %SYS.MFT.Connection.Kiteworks, filePath As %String, localFilePath As %String) As %Status
Download the specified remote file and store at the location given by localFilePath. filePath may be a file path. filePath may also be specified as an id of the form "id:" which was obtained from a %MFT.ItemInfo object.
DownloadStream
ClassMethod DownloadStream(connection As %SYS.MFT.Connection.Kiteworks, filePath As %String, ByRef stream As %BinaryStream) As %Status
Download the specified remote file and store in the specified stream which must be a %FileBinaryStream or a %GlobalBinaryStream. If stream is not specified, then a %GlobalBinaryStream will be created. filePath may be a file path. filePath may also be specified as an id of the form "id:" which was obtained from a %MFT.ItemInfo object.
ShareFolder
ClassMethod ShareFolder(connection As %SYS.MFT.Connection.Kiteworks, path As %String, accessLevel As %String = "viewer", users As %List) As %Status
Share a folder with a list of users pass as a $list. path may be a folder path. path may also be specified as an id of the form "id:" which was obtained from a %MFT.ItemInfo object. The "editor" and "viewer" access levels are supported for all vendors. The defined Kiteworks roles are supported as access levels. The editor access level becomes the Manager role and the viewer access level becomes the Viewer role. A Kiteworks user is specified as the email address associated with the account.
UnshareFolder
ClassMethod UnshareFolder(connection As %SYS.MFT.Connection.Kiteworks, path As %String, user As %String) As %Status
Unshare a folder from a specified user. path may be a folder path. path may also be specified as an id of the form "id:" which was obtained from a %MFT.ItemInfo object. A Kiteworks user is specified as the email address associated with the account.
UnshareFolderAll
ClassMethod UnshareFolderAll(connection As %SYS.MFT.Connection.Kiteworks, path As %String) As %Status
Unshare a folder from all users. path may be a folder path. path may also be specified as an id of the form "id:" which was obtained from a %MFT.ItemInfo object.
MountFolder
ClassMethod MountFolder(connection As %SYS.MFT.Connection.Kiteworks, folderName As %String) As %Status
MountFolder is a Dropbox specific method to mount a shared folder that was shared by a different user. MountFolder is treated as a NOP for all other services.
UnmountFolder
ClassMethod UnmountFolder(connection As %SYS.MFT.Connection.Kiteworks, folderName As %String) As %Status
UnmountFolder is a Dropbox specific method to unmount a shared folder that was shared by a different user. UnmountFolder is treated as a NOP for all other services.
GetRoleId
ClassMethod GetRoleId(connection As %SYS.MFT.Connection.Kiteworks, role As %String, Output roleId As %Integer) As %Status [ Internal ]
Get the role id that is associated with a role name.
CreateUser
ClassMethod CreateUser(connection As %SYS.MFT.Connection.Kiteworks, userInfo As %MFT.UserInfo) As %Status
Create a new user. The Userid and Detail properties are filled in by CreateUser if it is successful.
DeleteUserById
ClassMethod DeleteUserById(connection As %SYS.MFT.Connection.Kiteworks, userid As %String) As %Status
Delete the user that is specified by the id.
DeleteUser
ClassMethod DeleteUser(connection As %SYS.MFT.Connection.Kiteworks, username As %String) As %Status
Delete the user that is specified by the email address (i.e. username).
GetUserById
ClassMethod GetUserById(connection As %SYS.MFT.Connection.Kiteworks, userid As %String, Output userInfo As %MFT.UserInfo) As %Status
Retrieve the %MFT.UserInfo specified by the service defined Userid. If the user does not exist, then $$$OK is returned as status and userInfo is returned as "".
GetUser
ClassMethod GetUser(connection As %SYS.MFT.Connection.Kiteworks, username As %String, Output userInfo As %MFT.UserInfo) As %Status
Retrieve the %MFT.UserInfo specified by the username which is the email address for all currently supported services. GetUser is potentially less efficient than GetUserById. If the user does not exist, then $$$OK is returned as status and userInfo is returned as "".
GetUserList
ClassMethod GetUserList(connection As %SYS.MFT.Connection.Kiteworks, Output userList As %MFT.UserList) As %Status
Return the list of all currently defined users for this team or enterprise.
CreateUserInfo
ClassMethod CreateUserInfo(response As %DynamicObject) As %MFT.UserInfo [ Internal ]
Create an UserInfo object from a Kiteworks response