Rooms Class |
Namespace: BlackBerry.Workspaces.Resource
public class Rooms
The Rooms type exposes the following members.
Name | Description | |
---|---|---|
AddEntityToDocumentV30 |
Adds permitted entity to workspace with no permissions outside of the
given folder.
| |
AddEntityToFolderV30 |
Adds permitted entity to workspace with no permissions outside of the
given folder.
| |
AddEntityV30 |
This call adds a new entity to a workspace. Only groups domains users
and "everyone" may be direct members of a VDR. other entities (like
distributionlists) need to be members of a room group in order to gain
permission to the room.
| |
AddFolderPermissionRequestV30 |
Adds a new permission request for folder.
| |
AddMembersToGroupV30 |
Adds members (users) to a group.
| |
AddMembersV30 |
Adds members to a workspace.
| |
AddPermissionsV30 |
Adds permissions for entities (users/groups/domains) to a set of files
in a workspace. Permissions can be eg copy, print, edit, download etc.
| |
AddTagsV30 |
Adds tags to a list of files. Tags can be numerical, free text or
datestamps.
| |
ChangeDefaultPermissionsBulkV30 |
Changes default permissions of a permitted entity in a workspace.
| |
ChangeDefaultPermissionsV30 |
Changes default permissions of a permitted entity in a workspace.
| |
CopyDocumentsFromRoomsToExchangeAsyncV30 |
Submits files in Sent items (asynchronous).
| |
CopyDocumentsFromRoomsToExchangeV30 |
Submits files in Sent items. This submits room files to recipients
within SDS the files will be copied from the room to SDS
| |
CopyMembershipV30 |
Copies membership (of several users) to another existing user.
| |
CreateExternalFoldersTreeV30 |
Creates a folder in a workspace for each external folder in the tree.
| |
CreateFoldersBulkV30 |
Creates a folder in a workspace with a specified path. the workspace in
which the folder is to be created.
| |
CreateFoldersInFolderIfNewV30 |
Creates a folder in a workspace with a specified parent ID and name.
| |
CreateFoldersInFolderV30 |
Creates a folder in a workspace with a specified parent ID and name.
| |
CreateFoldersTreeAsyncV30 |
Creates a folder in a workspace for each folder in the tree
asynchronous.
| |
CreateFoldersTreeV30 |
Creates a folder in a workspace for each folder in the tree.
| |
CreateFoldersV30 | Obsolete.
Creates a folder in a workspace with a specified path.
| |
CreateNewDocumentV30 |
Create new empty document
| |
CreateRoomV30 |
Creates a workspace. Assign a name, description and list of
administrators for the room.
| |
DeleteDocumentsBulkV30 |
Deletes files and/or folders. The files and folders can be in different
rooms (workspaces) ??
| |
DeleteDocumentsV30 |
Deletes files and/or folders from a workspace.
| |
DeleteEntitiesV30 |
Deletes entities from a workspace. All permissions for the entity in the
room will be revoked as well.
| |
DeleteFolderV30 |
Deletes a folder and all of its subfolders and files from a workspace.
The user must have sufficient rights to delete the folders.
| |
DeleteRoomV30(String) | Obsolete.
Delete a room.
| |
DeleteRoomV30(DeleteRoomJson) |
Deletes a workspace and all its contents. The deletion can be
recoverable (from the recycle bin) or permanent.
| |
DocumentUploadCompleteV30 |
Completes the already uploaded by chunks file.
| |
DownloadDocumentsWithRecycleBinFormV30 |
Downloads files from the Recycle bin (Form) for a given workspace.
| |
DownloadDocumentsWithRecycleBinV30 |
Downloads files from the recycle bin for a given workspace. allowed for
workspace admins only
| |
DownloadGenericDocumentsV30 |
Creates and downloads a ZIP file containing all (original and protected)
files in a specified workspace.
| |
DownloadOriginalDocumentsV30 | Obsolete.
Creates and downloads a ZIP file containing original files.
| |
DownloadProtectedDocumentsV30 | Obsolete.
Creates and streams a ZIP file containing protected files.
| |
DownloadSingleRecycleBinDocumentV30 |
Downloads the original version of the file. Allowed only for workspace
admins
| |
EditFoldersAndDocumentsSettingsBulkV30 |
Edit folder permission settings - whether the folder should inherit
permissions from its parent, and whether to force descendants inherit.
| |
EditFolderSettingsV30 | Obsolete.
Edit folder permission settings - whether the folder should inherit
permissions from its parent, and whether to force descendants inherit.
| |
EditManagersToGroupV30 |
Edit managers on groups ( set or unset manager properties for users).
| |
EditPermissionsV30 |
Edit permissions for a list of files for a list of entities (users,
groups, etc).
| |
EditRoomV30 |
Renames a workspace.
| |
EntityListV30 |
List the workspace entities (groups/domain/users) that are members of
the workspace. This may only be done by users that have CRUD entities
privileges.
| |
EntityPagedListV30 |
List the room entities (groups/domain/everyone) that are members of the
room. This may only be done by users that have CRUD entities privileges.
This request returns a paged list
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
ExportGroupLogToJsonV30 |
Exports the workspace groups log to JSON.
| |
ExportGroupLogV30 |
Exports the workspace groups log.
| |
FoldersReadConfirmationEditV30 |
set the default read confirmation flag for folders
| |
GenerateGuidV30 |
Creates a GUID for a new file.
| |
GetActivityLogV30 | Obsolete.
Gets the activity log for a specific file. The log returns details of
all access activities for the file by any user or group.
| |
GetBulkEmailDataV30 |
Gets data for bulk email notifications.
| |
GetDocumentGUIDV30 |
Gets a document GUID.
| |
GetDocumentInfoV30 |
Gets information about a specific file in a workspace. The information
includes the file name, permissions, time of last update, date most
recently viewed, expiry date, tags, etc.
| |
GetDocumentLinksV30 |
Gets links for a file in a workspace. The link is a URI for the file.
| |
GetExternalTransactionStatusV30 |
Gets external transaction status.
| |
GetFolderInfoV30 |
Get info for a folder if it has been updated later than a specified
date. Info returned is folder name, subfolders, update date.
| |
GetFolderLinksV30 |
Gets links for a folder in a workspace. The link is a URI for the
folder.
| |
GetFolderTreeV30 |
Gets the tree of all folders and subfolders in a specified workspace.
| |
GetGroupInfoV30 |
Gets information about a group in a workspace.
| |
GetGroupsV30 |
Gets a list of all groups in a specified workspace.
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetInfoForAdminV30 |
Gets workspace info. The info includes the name, creation date, deletion
date, URL, product, access level, whether workspace is shared, explicit
| |
GetInfoV30 |
Gets workspace info. The info includes the name, creation date, deletion
date, URL, product, access level, whether workspace is shared, explicit
| |
GetInitialSyncStateForExternalRoomV30 |
Applies a decision on a request.
| |
GetInviteTextV30(String, String) |
Gets invite email message for workspace.
| |
GetInviteTextV30(String, String, String) |
Gets invite email message for file.
| |
GetPermissionsV30 |
Returns all permitted entities permitted to the workspace.
| |
GetRoomLinksV30 |
Returns the URL link to a workspace.
| |
GetRoomsTagValuesV30 |
Gets a list of tags for a list of the user's workspaces.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
InviteV30(String, InviteJson) |
Invite groups to a workspace.
| |
InviteV30(String, String, InviteJson) |
Invites groups to a specific file in a workspace.
| |
ListDocumentsForAdminV30 |
Lists all files in a specified workspace for admin console requests.
| |
ListDocumentsV30 |
Requests a list of all files in a specified workspace.
| |
ListFolderDefaultPermissionsV30 |
Available for workspace admins only. Shows permissions for each of the
default entities in given folder
| |
ListFolderPermissionRequestsV30 |
Lists existing permissions requests for folder or the entire workspace
where the root folder is supplied.
| |
ListFolderPermissionsBulkV30 |
Available for workspace admins only. Shows aggregation of permissions of
folders (not including expiration date)
| |
ListFoldersAndDocumentsV30 |
Lists all folders and files in the specified workspace.
| |
ListLastResolvedFolderPermissionRequestsV30 |
Lists last resolved permission requests on folder.
| |
ListPermissionDetailsV30 |
Lists permission details for files and folders bulkly for all entities
in the room.
| |
ListRoomsByTypeV30 | ||
ListRoomsForAdminV30 |
Retrieves a list of all the workspaces for a user with VIEW_ALL_ROOMS
capability.
| |
ListRoomsV30 |
Retrieves a list of all the workspaces of the current user.
| |
ListWorkspaceGroupMembershipsForUserV30 |
Lists groups in the workspace for a user.
| |
ListWorkspacesRecycleBinDocumentsV30 |
Lists files in the workspace Recycle bin. The recycle bin holds files
from workspaces that have been deleted, but not permanently.
| |
ListWorkspacesRecycleBinWorkspacesV30 |
Lists workspaces in the workspaces Recycle bin. The recycle bin holds
workspaces that have been deleted, but not permanently.
| |
LoadToCacheV30 |
Adds a workspace to cache (saved for offline).
| |
LockDocumentsV30 |
Locks files.
| |
MarkRoomAsExplicitV30 |
Marks a workspace as explicit.
| |
MarkV30(MarkDocumentsSelectionJson) |
Marks a specified list of files with a mark.
| |
MarkV30(String, MarkDocumentsSelectionVdrJson) |
Marks a specified list of files in a workspace.
| |
ModifyGroupV30 |
Use this function when you wish to change a group that already exists in
the workspace. You can change the group name and the group identifier
with this function.
| |
MoveAllV30 |
Moves all files from one folder in a workspace to another folder.
| |
MoveDocumentV30 |
Moves a file in a workspace to a new folder.
| |
MoveFolderIntoFolderV30 |
Moves a folder in a workspace (and its contents) to a new location
within the same workspace.
| |
MoveFolderV30 |
Moves a folder in a workspace (and its contents) to a new location
within the same workspace.
| |
MoveV30 |
Moves files in a workspace folder to a different folder within the same
workspace.
| |
OpenForAllRoomV30 |
Sets a workspace to be open to all entities (users, groups, domains
etc).
| |
RemoveAllTagsV30 |
Removes all tags for a specified file.
| |
RemoveClassificationV30 | Obsolete.
Removes classification from the given files. Notice that force action is
not supported for this action.
| |
RemoveMembersFromGroupV30 |
Removes members (users) from a group.
| |
RemoveTagsV30 |
Removes specified tags from a list of files.
| |
RemoveUserFromRoomDeprecatedV30 | Obsolete.
Removes a user from all the room groups. This will effectively revoke
permissions from the room for this user, unless the user's domain is a
member in the room, or the administrator opened the room for everyone.
| |
RenameDocumentV30 |
Renames a file in a workspace.
| |
RenameFolderV30 |
Renames a folder within a workspace.
| |
ResolveActionForFolderPermissionRequestV30 |
Applies a decision on a request.
| |
RestoreWorkspacesRecycleBinDocumentsV30 |
Restores files from Recycle bin. Files are restored to their original
workspaces and removed from the recycle bin.
| |
RestoreWorkspacesRecycleBinWorkspacesV30 |
Restores workspaces from Recycle bin.
| |
RevokePermissionsV30 |
Revokes all permissions for a list of entities (users, groups etc) for a
list of files in a workspace.
| |
SearchDocumentsForAdminV30 |
For use in Admin console: Search for files in workspaces according to a
search string. In order to search Tag fields you should use the
following syntax in the query String: query = "tagName1: (value1 OR
value2) tagName2: (value3) This query will fetch all files that have
value1 or value2 for tagName 1 and also have value 3 for tagName 2) it's
also possible to put OR between the two tagNames.
| |
SearchDocumentsV30 |
For use in MyDox: Search for files in workspaces according to a search
string. In order to search Tag fields you should use the following
syntax in the query String: query = "tagName1: (value1 OR value2)
tagName2: (value3) This query will fetch all files that have value1 or
value2 for tagName 1 and also have value 3 for tagName 2) it's also
possible to put OR between the two tagNames.
| |
SendBulkEmailV30 |
Sends bulk email notifications for a list of files to all permitted
entities (users, groups etc) for each file. The emails are sent
immediately.
| |
SendEmailV30 |
Sends email to group of recipients with a message regarding a specific
file in a workspace.
| |
SetClassificationV30 | Obsolete.
Sets files classifications.
| |
SetModifiedDateV30 | Obsolete.
Sets file modified date.
| |
SetSharepointProtectorV30 |
Sets protect anywhere policy for a workspace.
| |
SetUpdateDataV30 |
Sets files update data.
| |
SubmitDocumentIfNewV30 |
Submits a file to a room if the file is new (ie not a new version of an
existing file). The submit action follows a file upload to a room, and
sends, for example, email notifications to entities (users, groups etc).
| |
SubmitDocumentsV30 |
Submits files to a workspace. The submit action is requested after files
have been uploaded to a workspace, to notify entities (users, groups
etc)
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
UnlockDocumentsV30 |
Unlock files.
| |
UpdateDocumentV30 | Obsolete.
Update a file in a workspace. The update action uploads the file to the
server and sends an email notification to all entities (users, groups)
with permissions for the file.
| |
UploadBlobV30 |
Uploads a file to a workspace and generates a new GUID for it.
| |
UploadDocumentBase64V30 |
Uploads a file to a workspace in base64.
| |
UploadDocumentByPostV30(String, String, FileInfo, DeviceType, String, String, Int64, IProgressChanged) |
Uploads a file to a workspace.
| |
UploadDocumentByPostV30(String, String, Stream, DeviceType, String, String, Int64, IProgressChanged) |
Uploads a file to a workspace.
| |
ValidateCreateFolderV30 |
Validates the parameters are ok for adding folder.
| |
ValidateDocumentsToDownloadFromRecycleBinV30 |
Validates files to download from a Recycle bin.
| |
ValidateDocumentsToDownloadV30(ValidateDownloadDocumentVersionInVdrsJson) |
Validates the file versions for download from a list of files.
| |
ValidateDocumentsToDownloadV30(String, ValidateDownloadDocumentsSelectionVdrJson) |
Validates a list of files for download from a specific workspace.
|