Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
AddDocumentEntity
Give user permissions to a particular workspace file only.
Parameters
Name Type Description

description

String

Deprecated
Default value: ""

Set description (only for groups)

documentGuids

Set(String)

Required
Not null

Set of file guids

emailMessage

String

Text of email

emailSubject

String

Subject line for notification email

expirationDate

Date

Deprecated

Use the expiration field on the permissionsTemplate

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. Relevant only if permittedEntity is a roomGroup

isSendMail

boolean

Default value: false

Flag indicating that a notification email should be sent to recipients

isWatermark

boolean

Deprecated
Default value: true

permissionsTemplate

PermissionsTemplateRequest

Required

Permission template to apply to files

permittedEntity

PermittedEntityFromUser

Deprecated

Single Entity to add

role

String

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,
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
}),
permissionsTemplate:
{
templateName: String,
waterMark: Boolean,
watermark: Boolean,
comment: Boolean,
expirationDate: Date
},
roomId: Integer,
roomGuid: String,
documentGuids: Set(String),
expirationDate: Date,
isWatermark: Boolean,
isSendMail: Boolean,
emailSubject: String,
emailMessage: 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
}
})
})
}