Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
SdsAddPermissions
Information for adding SDS permissions
Parameters
Name Type Description

documentFilter

ApiDocumentFilter

File filter (to obtain list of files). Either pass this or documentGuids

Possible values: [ALL, ABOUT_TO_EXPIRE, RECENTLY_VIEWED, VALID_ONLY, SHARED_BY_ME, HIDDEN, RECENTLY_MODIFIED, SHARED_WITH_ME].

documentGuids

Set(String)

List of file guids. Either pass this or documentFilter

emailMessage

String

Email message

emailSubject

String

Subject line for email

isSendMail

boolean

Flag indicating whether to send email to recipients

permissionSet

PermissionSet

Set of permissions

permissionTemplate

PermissionsTemplateRequest

recipients

List(PermittedEntityFromUser)

Required

List of recipients

whoCanView

WhoCanView

Default value: RECEIPIENTS_ONLY

Who can view files. From EVERYONE, RECIPIENTS_ONLY or ANYONE_WITH_RECIPIENTS_DOMAIN

Possible values: [RECEIPIENTS_ONLY, ANYONE_WITH_RECEIPIENTS_DOMAIN, EVERYONE].

Json Format
{
recipients: List(
{
address: String,
entityType: EntityType
}),
permissionSet:
{
downloadOriginal: YesNoDefault,
downloadControlled: YesNoDefault,
copy: YesNoDefault,
print: YesNoDefault,
edit: YesNoDefault,
spotlight: YesNoDefault,
watermark: YesNoDefault,
expiration: ExpirationOptions,
expirationDate: Date,
programmaticAccess: YesNoDefault,
comment: YesNoDefault
},
permissionTemplate:
{
templateName: String,
waterMark: Boolean,
watermark: Boolean,
comment: Boolean,
expirationDate: Date
},
documentGuids: Set(String),
documentFilter: ApiDocumentFilter,
whoCanView: WhoCanView,
isSendMail: Boolean,
emailSubject: String,
emailMessage: String
}