Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
SubmitDocumentSds
These parameters are needed when submitting files in SDS mode (not to a workspace).
Parameters
Name Type Description

activeDirectoryGroupsRecipients

Set(String)

Not null
Default value: new HashSet<>()

A list of activeDirectory group guids that are intended to be recipients of these files. May be left null. Can be sent empty or not sent.

deviceType

DeviceType

Default value: null

Possible values: [SALESFORCE_PLUGIN, GOOGLE_DRIVE, BROWSER, SRE, CMIS, CIFS, MAC, UPLOADER, OFFICE_ONLINE, SHAREPOINT, ANDROID_APP, ONE_DRIVE, BLACKBERRY_APP, SDK, WINDOWS_PLUGIN, IOS_APP, SYNC, CHROME_EXTENSION].

documentGuids

Set(String)

Required

The list of file guids to submit.

isCollaboration

boolean

Default value: false

Indicates whether the files are sent for collaboration.

isOpenToAnyone

boolean

Indicates whether the file is sent using SimpleShare which means no authentication is required to view/download.

isSendEmail

Boolean

Not null
Default value: FALSE

If set to True the server will notify recipients via email about new documents submitted.

listRecipients

Set(String)

Not null
Default value: new HashSet<>()

A list of distribution list names that are intended to be recipients of these files. May be left null. Can be sent empty or not sent.

mailMessage

String

mailSubject

String

modifiedDate

Date

permission

PermissionFromUser

Required
Not null

The permissions to grant to recipients of this file.

readConfirmation

Boolean

Default value: false

Indicates is read confirmation is required for this document.

userRecipients

Set(String)

Not null
Default value: new HashSet<>()

A list of mails for users that are intended to be recipients of these files. Can be sent empty or not sent.

whoCanView

WhoCanView

Not null
Default value: RECEIPIENTS_ONLY

In case Domain permissions or file that are available to everyone, use this parameter. Only recipients that are recipients of this file (directly of by a distribution list) will be notified that this file exist.

Possible values: [RECEIPIENTS_ONLY, ANYONE_WITH_RECEIPIENTS_DOMAIN, EVERYONE].

Json Format
{
userRecipients: Set(String),
listRecipients: Set(String),
activeDirectoryGroupsRecipients: Set(String),
permission:
{
downloadOriginal: Boolean,
download: Boolean,
copy: Boolean,
print: Boolean,
edit: Boolean,
spotlight: Boolean,
watermark: Boolean,
expirationDate: Date,
defaultExpirationDays: Integer,
neverExpires: Boolean,
progAccess: Boolean,
comment: Boolean
},
whoCanView: WhoCanView,
isSendEmail: Boolean,
mailSubject: String,
mailMessage: String,
documentGuids: Set(String),
deviceType: DeviceType,
modifiedDate: Date,
isOpenToAnyone: Boolean,
isCollaboration: Boolean,
readConfirmation: Boolean
}