Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
TransientFolderInfoResult
Result from getting a single folder level
Parameters
Name Type Description

folder

String

Deprecated

Parent folder of the folder

folderCapabilities

List(WorkspaceCapabilityType)

Not null
Default value: new HashSet<>()

List of folder capabilities

folderRole

String

Folder role

fullPath

String

Full path from the workspace root

fullPathDisplay

String

Full path for display. It is same as fullPath except for Box repository, which removes the leading ownerId. Example: "/8221421110/chapter6/FolderTest2222" -> "/chapter6/FolderTest2222"

hasSubfolders

Boolean

Whether the folder has sub folders.

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.

parentId

Integer

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

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,
fullPathDisplay: 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,
folderCapabilities: Set(WorkspaceCapabilityType ),
folderRole: String
}