Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
AddFolderEntity
List information when adding a user to a workspace.
Parameters
Name Type Description

description

String

Deprecated
Default value: ""

Set description (only for groups) relevant only if permittedEntity is a roomGroup

emailMessage

String

emailSubject

String

folderPathOrId

PathOrFolderId

Path or id for the folder to be changed, if not supplied the root folder will be assumed

groupMembers

AddMembersToGroup

Deprecated

In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.

identifier

String

Deprecated

Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations. relvant only if permittedEntity is a roomGroup

includeAllSubItems

Boolean

Default value: false

isDefaultEntity

boolean

Default value: false

Set if the entity is default for workspace

isSendMail

boolean

Default value: false

newPermissions

PermissionFromUser

Required
Not null

Workspace permissions

permittedEntity

PermittedEntityFromUser

Deprecated

Single entity to add.

role

String

Not null

The new role in the workspace.

roomEntities

Set(PermittedEntityFromUser)

Not null
Default value: new HashSet<>()

roomGroups

List(GroupAndMembers)

Not null
Default value: new ArrayList<>()

roomGuid

String

Guid of the workspace

roomId

Integer

Id of the workspace

Json Format
{
permittedEntity:
{
address: String,
entityType: EntityType
},
identifier: String,
isDefaultEntity: Boolean,
role: String,
description: String,
groupMembers:
{
membersList: List(
{
entity:
{
address: String,
entityType: EntityType
}
}),
managersList: List(
{
entity:
{
address: String,
entityType: EntityType
}
}),
emailSubject: String,
emailMessage: String,
isSendMail: Boolean
}),
newPermissions:
{
downloadOriginal: Boolean,
download: Boolean,
copy: Boolean,
print: Boolean,
edit: Boolean,
spotlight: Boolean,
watermark: Boolean,
expirationDate: Date,
defaultExpirationDays: Integer,
neverExpires: Boolean,
progAccess: Boolean,
comment: Boolean
},
folderPathOrId:
{
path: String,
folderId: Integer,
folderGuid: String
},
roomId: Integer,
roomGuid: String,
roomEntities: Set(
{
address: String,
entityType: EntityType
}),
roomGroups: List(
{
groupName: String,
description: String,
membersList: List(
{
entity:
{
address: String,
entityType: EntityType
}
}),
managersList: List(
{
entity:
{
address: String,
entityType: EntityType
}
})
}),
emailSubject: String,
emailMessage: String,
isSendMail: Boolean,
includeAllSubItems: Boolean
}