Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
NewSession
Details of a new session that was created
Parameters
Name Type Description

deviceInfo

DeviceInfo

Device info

rooms

ItemList

Used to return the workspace list when prefetchRooms parameter was passed along with the login information.

serverRevision

Integer

Server revision

serverVersion

String

Server version

ssid

String

Secure session token

Json Format
{
ssid: String,
deviceInfo:
{
activeUser: String,
fullName: String,
isToWipe: Boolean,
availableUsers: List(String),
availableUsersInfo: List(
{
name: String,
email: String
})
}),
rooms:
{
total: Integer,
items: List(T)
}),
userData:
{
email: String,
fullName: String,
roomList:
{
total: Integer,
items: List(T)
}),
abilities:
{
admin: Boolean,
advancedSearch: Boolean,
canSend: Boolean,
noDownloadControlled: Boolean,
daysDocumentAvailable: Integer,
daysDocumentAvailableAfterExpiration: Integer,
maxDocumentSize: Integer,
maxStorageSize: long,
numberOfAttachmentsPerEmail: Integer,
numberOfRecipientsPerEmail: Integer,
numberOfMaxUploadNewVersion: Integer,
sendFlavor: Boolean,
spotlight: Boolean,
vdrFlavor: Boolean,
fullLogExport: Boolean,
offlineSeal: Boolean,
curtain: Boolean,
horizontalWatermark: Boolean,
noPdfPrinters: Boolean,
secureTransferMode: Integer,
noViewerForDownloadOriginal: Boolean,
secureTransferNotAllowed: Boolean,
orgAdminsCannotTrack: Boolean,
roomAdminsCannotTrack: Boolean,
forwardBlocked: Boolean,
downloadDefaultOriginal: Boolean,
downloadDefaultOff: Boolean,
watermarkDefaultOff: Boolean,
sortByLastModified: Boolean,
watermarkOriginal: Boolean,
pinRequired: Boolean,
javaPrintingDisabled: Boolean,
noDownload: Boolean,
enableAdvancedUploader: Boolean,
showFilters: Boolean,
noContentSearch: Boolean,
paidSICFlavor: Boolean,
isSdsTab: Boolean,
showFeedback: Boolean,
showLinkToOldInterface: Boolean,
enableWecaConversion: Boolean,
hasAccessToActiveDirectory: Boolean,
enableMobileEditing: Boolean,
enableSharepointExternalRepository: Boolean,
enableBlacklisting: Boolean,
enableNewUi: Boolean,
enableNewUiForAdmin: Boolean,
enableUsageReports: Boolean,
enableSyncPoint: Boolean,
modifyProductName: Boolean,
enableSharePointProtector: Boolean,
enableDRM: Boolean,
enableSyslog: Boolean,
enableICAP: Boolean,
enableAdProvisioning: Boolean,
enableLegalHold: Boolean,
enableTieredAdministratorRoles: Boolean,
enableDocumentTags: Boolean,
enableSyncPolicies: Boolean,
enableSimpleSharing: Boolean,
enableFileRetention: Boolean,
enableCustomLogo: Boolean,
enableChangeLinks: Boolean,
enableMyDox: Boolean,
enableSalesForce: Boolean,
enableCmis: Boolean,
enableCmisExternalize: Boolean,
enableWorkspaceRoleBuilder: Boolean,
enableLargeFilesOutlook: Boolean,
enableWopi: Boolean,
enableDocuSign: Boolean,
enableComments: Boolean,
enableLockingDocuments: Boolean,
enableReadConfirmation: Boolean,
adminConsoleMisc: Boolean,
enableReportsAuthentication: Boolean,
enableRestoreToSnapshot: Boolean,
enableIManage: Boolean,
enableBYOK: Boolean,
exchangesPolicy:
{
allowPrintingToPdf: Boolean,
disableCurtain: Boolean,
disablePasscodeLock: Boolean,
allowNonControllableFileTypes: Boolean,
protectImagesInExchangeDocuments: Boolean,
useAutoComplete: Boolean,
enableSimpleSharing: Boolean,
simpleSharingDefault: Boolean,
disableWdSentItems: Boolean,
enableReadConfirmation: Boolean,
readConfirmByDefault: Boolean,
supportedTypes: Set(String)
}),
workspacesPolicy:
{
allowPrintingToPdf: Boolean,
disableCurtain: Boolean,
disablePasscodeLock: Boolean,
allowNonControllableFileTypes: Boolean,
protectImagesInWorkspaces: Boolean,
useAutoComplete: Boolean,
supportedTypes: Set(String),
allowEditDescription: Boolean,
logAccessActionsToFiles: Boolean,
enableReadConfirmation: Boolean,
readConfirmByDefault: Boolean,
fileUploadNotifyWorkspaceMembersDefault: Boolean
})
}),
logoUrl: String,
tags: List(
{
name: String,
type: String,
values: List(String)
}),
mainServer: String,
organizationSubdomainCustomization:
{
termsAndConditionsUrl: String,
privacyPolicyUrl: String,
supportUrl: String,
helpUrl: String,
contactUsUrl: String,
useDefaultLogo: Boolean,
productName: String,
logoUrl: String,
gettingStartedLink: String,
downloadPluginWindowsUrl: String,
downloadPluginMacUrl: String,
showDownloadPluginWindowsLink: Boolean,
showDownloadPluginMacLink: Boolean,
userGuideLink: String,
quickStartGuideLink: String,
showUserGuideLink: Boolean,
showQuickStartGuideLink: Boolean,
showGettingStartedLink: Boolean,
sendWelcomeEmail: Boolean,
showAboutUsLink: Boolean,
showContactUsLink: Boolean,
showHelpLink: Boolean,
showSupportLink: Boolean,
aboutUsLink: String,
showSupportAdministratorsEmail: Boolean,
supportAdministratorsEmailList: Set(String),
isDefaultSupportEmails: Boolean,
downloadDesktopAppUrl: String,
downloadAndroidAppUrl: String,
downloadIosAppUrl: String,
watchVideoUrl: String,
contactSupportLink: String,
showContactSupportLink: Boolean
}),
organizationCustomization:
{
allowUserSwitchAccounts: Boolean,
vdrDefaultDocOrder: ApiDocumentOrderVDR,
sicDefaultDocOrder: ApiDocumentOrderVDR
},
organizationPolicyJson:
{
isAllowedToShareAnnotationsWithWorkspaceAdmins: Boolean,
isAllowedToShareAnnotationsWithAllWorkspaceGroups: Boolean,
isAllowedToShareAnnotationsWithSelectedGroups: Boolean,
isAllowedToShareAnnotationsWithUsersManually: Boolean,
allowDownloadOriginal: Boolean,
allowDownloadProtected: Boolean,
isAllowedToShareDocumentsWithWorkspaceAdmins: Boolean,
isAllowedToShareDocumentsWithAllWorkspaceGroups: Boolean,
isAllowedToShareDocumentsWithSelectedGroups: Boolean,
isAllowedToShareDocumentsWithUsersManually: Boolean,
allowMobileIos: Boolean,
allowMobileAndroid: Boolean,
allowMobileBlackberry: Boolean,
allowMobileWindowsMobile: Boolean,
deleteFromDisk: Boolean,
licenseHoursValid: Integer,
defaultChangeGroupsToAllDocs: Boolean,
defaultAddGroupsAsDefaultEntity: Boolean,
allowOpenOriginalsInOtherApps: Boolean,
allowOpenUnsupportedInOtherApps: Boolean,
enableRmsSealing: Boolean,
uploadBandwidthLimit: Integer,
downloadBandwidthLimit: Integer,
enableBandwidthLimit: Boolean,
globalDownloadControlled: Boolean,
enableCloudStorageWorkspaces: Boolean,
allowTrackingFromMicrosoftOfficeDocuments: Boolean,
blockNonProvisionedUsers: Boolean,
enableSalesForce: Boolean,
enableWivi: Boolean,
enableOnlineViewerForUnsupportedBrowsers: Boolean,
enableWopi: Boolean,
allowLockingDocuments: Boolean,
useAutoComplete: Boolean,
autoCompleteAllowToAll: Boolean,
autoCompleteDisplayAll: Boolean,
wopiDiscoveryUrl: String,
enableSharingWithoutEmailNotification: Boolean,
shareFilesWithNotificationByDefault: Boolean,
isDisableOnBehalfOfForAllOutgoingEmails: Boolean,
enableComments: Boolean,
commentsDefaultValue: Boolean,
sendWeeklyLicensingReport: Boolean,
sendWeeklyInternalDomainLicensingReport: Boolean,
enablePushNotifications: Boolean,
sendMissingSetupNotificationEmails: Boolean,
sendDailyActivityEmail: Boolean,
enableFetchMembers: Boolean,
forcePinWorkspaces: Boolean,
displayCommentContent: Boolean,
allowAdvancedPrinting: Boolean,
customizedNotificationsEmails: Boolean,
disallowChangeToPermissionTemplates: Boolean
},
orgCapabilities: Set(OrgCapabilityType ),
defaultExchangePermissions:
{
canCopy: Boolean,
canEdit: Boolean,
canPrint: Boolean,
spotlight: Boolean,
canDownloadOriginal: Boolean,
canDownloadProtected: Boolean,
watermark: Boolean,
programmaticAccess: Boolean,
comment: Boolean,
expirationDate: Date,
defaultExpirationDays: Integer,
curtain: Boolean,
pdfPrint: Boolean,
whoCanView: Integer
},
isAppliance: Boolean,
sendNotifications: Boolean,
userGuid: String,
timezoneOffset: Integer,
didModifyWorkspaceList: Boolean,
organizationSyncPolicyJson:
{
blacklistExpressions: Set(String),
whitelistExpressions: Set(String),
maxSize: Long
}),
language: String,
createWorkspacesForOrg: Boolean,
enableChunkedDownloads: Boolean,
permissionTemplateOverride: Boolean,
enableVideoFile: Boolean,
canChangePermissions: Boolean
}),
serverVersion: String,
serverRevision: Integer
}