Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
FolderInfo
Details about a single folder
Parameters
Name Type Description

folder

String

Deprecated

folderCapabilities

List(WorkspaceCapabilityType)

Not null
Default value: new HashSet<>()

folderPathToUuidJsons

Set(FolderPathToUuid)

folderRole

String

fullPath

String

Full path from the room root

hasSubfolders

Boolean

Whether the folder has sub folders.

id

Integer

Id for the folder

isPermissionsInherited

Boolean

are permissions inherited from parent

lastFileModifiedDate

Date

max last modified date of files in folder, include sub folders

name

String

Name of folder.

originalReadAckState

Boolean

Default value: false

parentId

Integer

Parent folder of the folder

readConfirmationIncludeSubfolder

Boolean

Default value: false

readConfirmationRequired

Boolean

Default value: false

is read confirmation required for files in this folder

room

String

Deprecated

Workspace ID of the folder

subFolders

List(Folder)

Not null
Default value: new ArrayList<>()

List of subfolders. None if there are no subfolders.

totalCount

Integer

Default value: 0

# of files in folder, include sub folders

totalFilesSize

Long

Default value: 0L

Size in MB for all files in this folder, include sub folders

updateDate

Date

Folder's update date.

uuid

String

UUID of the folder

workspaceUuid

String

Json Format
{
id: Integer,
uuid: String,
name: String,
updateDate: Date,
hasSubfolders: Boolean,
room: String,
folder: String,
parentId: Integer,
subFolders: List(
{
id: Integer,
isPermsInherited: Boolean,
uuid: String,
name: String,
updateDate: Date,
hasSubfolders: Boolean,
room: String,
roomUUID: String,
folder: String,
parentId: Integer,
parentGuid: String,
subFolders: List(Folder ),
fullPath: String,
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
folderCapabilities: Set(WorkspaceCapabilityType ),
folderRole: String,
readConfirmationRequired: Boolean,
readConfirmationIncludeSubfolder: Boolean,
originalReadAckState: Boolean,
starred: Boolean,
starredDate: Date
}),
fullPath: String,
externalRepositoryData:
{
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
folderExternalData:
{
id: Integer,
items: Set(
{
key: String,
value: String
})
})
}),
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
totalFilesSize: Long,
totalCount: Integer,
lastFileModifiedDate: Date,
isPermissionsInherited: Boolean,
readConfirmationRequired: Boolean,
readConfirmationIncludeSubfolder: Boolean,
originalReadAckState: Boolean,
folderCapabilities: Set(WorkspaceCapabilityType ),
folderRole: String,
workspaceUuid: String,
folderPathToUuidJsons: Set(
{
uuid: String,
fullPath: String
})
}