| Client Methods |
The Client type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Equals | (Inherited from Object.) |
| FileCopy |
Copies a file from the specified path to the specified folder.
|
| FileCopyAndConvert |
Copies a WebPost file from the specified path to the specified folder and converts it to the specified format.
|
| FileDelete |
Deletes the file with the specified path.
|
| FileDownload |
Downloads the specified file from the MOVEit Transfer system into the specified local folder.
|
| FileDownloadAs |
Downloads the specified file from the MOVEit Transfer system into a file with the specified full path.
|
| FileDownloadToBuffer |
Downloads the specified file from the MOVEit Transfer system and returns the contents.
|
| FileDownloadToStream |
Downloads the specified file from the MOVEit Transfer system and writes the contents to the specified stream.
|
| FileExists |
Returns true if the specified file exists and the currently authorized user may access it; returns false otherwise.
|
| FileGetDetails |
Returns a MOVEitFileInfo object containing information about the specified file.
|
| FileMove |
Moves a file from the specified path to the specified folder.
|
| FileMoveAndConvert |
Moves a WebPost file from the specified path to the specified folder and converts it to the specified format.
|
| FileRename |
Renames the specified file to the given name.
|
| FileUpload(String, String) |
Uploads the specified file into the specified MOVEit Transfer folder.
|
| FileUpload(String, String, String) |
Uploads the specified file into the specified MOVEit Transfer folder.
|
| FileUploadAs(String, String) |
Uploads the specified file into the specified MOVEit Transfer folder.
|
| FileUploadAs(String, String, String) |
Uploads the specified file into the specified MOVEit Transfer folder.
|
| FileUploadFromBuffer(Byte, String) |
Uploads the specified byte array to MOVEit Transfer as the specified file.
|
| FileUploadFromBuffer(Byte, String, String) |
Uploads the specified byte array to MOVEit Transfer as the specified file.
|
| FileUploadFromStream(Stream, String) |
Uploads from the specified stream to MOVEit Transfer as the specified file.
|
| FileUploadFromStream(Stream, Int64, String) |
Uploads from the specified stream to MOVEit Transfer as the specified file.
|
| FileUploadFromStream(Stream, String, String) |
Uploads from the specified stream to MOVEit Transfer as the specified file.
|
| FileUploadFromStream(Stream, Int64, String, String) |
Uploads from the specified stream to MOVEit Transfer as the specified file.
|
| FolderAccessAddGroup |
Grants the specified group access to this folder.
|
| FolderAccessAddUser |
Grants the specified user access to this folder.
|
| FolderAccessDeleteGroup |
Denies the specified group access to this folder.
|
| FolderAccessDeleteUser |
Denies the specified user access to this folder.
|
| FolderAccessList |
Returns a Dictionary object containing string pairs of users and groups with access to this folder.
|
| FolderAdd |
Makes a new MOVEit Transfer folder with the given path.
|
| FolderChangeSetting |
Changes the specified setting on the specified folder.
|
| FolderDelete |
Deletes an existing MOVEit Transfer folder with the given path.
|
| FolderFindFiles(String) |
Returns a List of MOVEitFileInfo objects which contain
information about files in any available folder whose names match the specified mask.
|
| FolderFindFiles(String, String) |
Returns a List of MOVEitFileInfo objects which contain
information about files whose names match the specified mask, and which are located
in folders whose MOVEitFolder path is or begins with the provided MOVEitFolder.
|
| FolderFindNewFiles(String) |
Returns a List of MOVEitFileInfo objects which contain
information about NEW files in any available folder whose names match the specified mask.
|
| FolderFindNewFiles(String, String) |
Returns a List of MOVEitFileInfo objects which contain
information about NEW files whose names match the specified mask, and which are located
in folders whose MOVEitFolder path is or begins with the provided MOVEitFolder.
|
| FolderGetDetails |
Returns a MOVEitFolderInfo object containing information about the specified folder.
|
| FolderGetHome |
Returns a MOVEitFolderInfo object which corresponds to the named user's home folder.
|
| FolderListFiles |
Returns a List of MOVEitFileInfo objects which contain
information about files in the specified folder.
|
| FolderListFilesWithMask |
Returns a List of MOVEitFileInfo objects which contain
information about files in the specified folder whose names match the specified mask.
|
| FolderListFolders |
Returns a List of MOVEitFolderInfo objects which
contain information about subfolders of the specified folder.
|
| FolderListFoldersAll |
Returns a List of MOVEitFolderInfo objects which
contain information about all folders the currently authorized user can access.
|
| FolderListFoldersAll(String) |
Returns a List of MOVEitFolderInfo objects which
contain information about all folders the currently authorized user can access.
|
| FolderRename |
Renames an existing MOVEit Transfer folder with the given path.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MessageBoxAdd |
Makes a new MOVEit Transfer mailbox with the given path.
|
| MessageBoxDelete |
Deletes an existing MOVEit Transfer mailbox with the given path.
|
| MessageBoxListMessageBoxesAll |
Returns a List of
MOVEitFolderInfo objects which contain
information about all mailboxes the currently authorized user owns.
|
| MessageBoxListMessages |
Returns a List of
MOVEitMessageInfo objects which contain information about
all messages in the specified mailbox.
|
| MessageBoxListMessagesNew |
Returns a List of
MOVEitMessageInfo objects which contain information about
all new (unread) messages available to the current user.
|
| MessageBoxRename |
Renames an existing MOVEit Transfer mailbox with the given path.
|
| MessageComposeNew |
Returns a new MOVEitMessageInfo object with a state of "Pending".
|
| MessageComposeNew(String) |
Returns a new MOVEitMessageInfo object with a state of "Pending".
|
| MessageComposeNew(String, String) |
Returns a new MOVEitMessageInfo object with a state of "Pending".
|
| MessageComposeNew(String, String, String) |
Returns a new MOVEitMessageInfo object with a state of "Pending".
|
| MessageDelete |
Deletes message from all of the currently authorized user's mailboxes.
|
| MessageMove |
Moves message to the specified MOVEit Transfer mailbox.
|
| MessageRead |
Returns a MOVEitMessageInfo object describing the message identified by the given ID.
|
| MessageSend |
Sends a message to MOVEit Transfer.
|
| OrgGetSAMLInfo |
Returns a MOVEitSAMLInfo object describing the available
SAML authentication settings and servers for the default MOVEit Transfer organization.
|
| OrgGetSAMLInfo(String) |
Returns a MOVEitSAMLInfo object describing the available
SAML authentication settings and servers for the provided MOVEit Transfer organization.
|
| ReportRun |
Runs the specified report and saves it to the specified local path.
|
| ReportRunCustom |
Runs a custom report with the specified custom options and output format
and saves it to the specified local path.
|
| SAMLSignon |
Sign on to the configured MOVEit Transfer host using a SAML assertion.
|
| Signoff |
Sign off of the configured MOVEit Transfer host.
|
| Signon |
Sign on to the configured MOVEit Transfer host.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UserAdd(String, String, String, String, ClientUserPermission) |
Adds a new user with the provided attributes.
|
| UserAdd(String, String, String, String, ClientUserPermission, String) |
Adds a new user with the provided attributes.
|
| UserAdd(String, String, String, String, ClientUserPermission, String, Boolean) |
Adds a new user with the provided attributes.
|
| UserAdd(String, String, String, String, ClientUserPermission, String, Boolean, String) |
Adds a new user with the provided attributes.
|
| UserAddressBookAddGroup(String, String) |
Adds a group to the specified owner's address book.
|
| UserAddressBookAddGroup(String, String, Boolean) |
Adds a group to the specified owner's address book.
|
| UserAddressBookAddUser |
Adds a user to the specified owner's address book.
|
| UserAddressBookDeleteGroup |
Deletes a group from the specified owner's address book.
|
| UserAddressBookDeleteUser |
Deletes a user from the specified owner's address book.
|
| UserAddressBookList |
Returns a Dictionary containing the contents of the listed user's address book.
|
| UserAddressBookLookup |
Given a piece of identifying information, determines if the referenced user or group is a
member of the currently authorized user's address book.
|
| UserAddTemporary(String, String, String) |
Adds a new temporary user with the provided attributes.
|
| UserAddTemporary(String, String, String, Boolean) |
Adds a new temporary user with the provided attributes.
|
| UserCertKeyAdd |
Adds an SSL certificate or SSH key to a user's store using provided data.
|
| UserCertKeyList |
Returns a list of SSL certificates and SSH keys in the user's store.
|
| UserCertKeyRemove |
Removes an SSL certificate or SSH key from a user's store.
|
| UserChangePassword |
Changes the password of the specified user.
|
| UserChangeSetting |
Changes the specified setting on the specified user.
|
| UserChangeStatus(String, String) |
Changes the status of the specified user.
|
| UserChangeStatus(String, String, String) |
Changes the status of the specified user.
|
| UserClone(String, String, String, String, String) |
Adds a new user with the provided attributes by cloning the specified original user.
|
| UserClone(String, String, String, String, String, String) |
Adds a new user with the provided attributes by cloning the specified original user.
|
| UserClone(String, String, String, String, String, String, Boolean) |
Adds a new user with the provided attributes by cloning the specified original user.
|
| UserDelete |
Deletes the specified user.
|
| UserGetDetails |
Returns a MOVEitUserInfo object containing information about the specified user.
|
| UserGroupAdd(String) |
Adds a new group with the provided name.
|
| UserGroupAdd(String, String) |
Adds a new group with the provided name and description.
|
| UserGroupAddressBookAddGroup(String, String) |
Adds a group to the specified owner group's address book.
|
| UserGroupAddressBookAddGroup(String, String, Boolean) |
Adds a group to the specified owner group's address book.
|
| UserGroupAddressBookAddUser |
Adds a user to the specified owner group's address book.
|
| UserGroupAddressBookDeleteGroup |
Deletes a group from the specified owner group's address book.
|
| UserGroupAddressBookDeleteUser |
Deletes a user from the specified owner group's address book.
|
| UserGroupChangeMembership |
Changes the relationship of the given user to the given group.
|
| UserGroupChangeSetting |
Changes the specified setting on the specified group.
|
| UserGroupDelete |
Deletes the specified group.
|
| UserGroupGetDetails |
Returns a MOVEitUserGroupInfo object containing information about the specified group.
|
| UserGroupJoin |
Adds the specified user to the specified group.
|
| UserGroupLeave |
Removes the specified user from the specified group.
|
| UserGroupList |
Returns a List of groups
the specified user belongs to.
|
| UserGroupListAll |
Returns a List of all groups
in the current organization.
|
| UserGroupListAll(String) |
Returns a List of all groups
in the specified organization.
|
| UserGroupListMembers |
Returns a List of all
users in the specified group.
|
| UserGroupListNot |
Returns a List of groups
the specified user does not belong to.
|
| UserGroupMemberList |
Returns a List of all
users in the specified group.
|
| UserList |
Returns a List of users in the current organization.
|
| UserList(String) |
Returns a List of users in the specified organization.
|
| UserListAdvanced(Int32, Int32) |
Returns a List of users in the current organization.
|
| UserListAdvanced(Int32, Int32, ClientUserPermissionFilter, ClientUserStatusFilter, String, ClientUserSearchStringFilter, String) |
Returns a List of users in the current organization.
|
| UserListAdvanced(Int32, Int32, ClientUserPermissionFilter, ClientUserStatusFilter, String, ClientUserSearchStringFilter, String, String) |
Returns a List of users in the specified organization.
|
| UserMakeRandomPassword |
Returns a randomly generated password that is acceptable by the password length and
strength standards of the currently signed on user's organization.
|
| UserSshKeyImportFromBuffer |
Imports an SSH public key to a user's certificate store.
|
| UserSshKeyImportFromFile |
Imports an SSH public key to a user's certificate store from a file.
|
| UserSslCertImportFromBuffer |
Imports an SSL public certificate to a user's certificate store.
|
| UserSslCertImportFromFile |
Imports an SSL public certificate to a user's certificate store from a file.
|
See Also