Class AddDocumentEntityJson
java.lang.Object
com.blackberry.workspaces.sdk.api.json.BaseJson
com.blackberry.workspaces.sdk.api.json.AddDocumentEntityJson
- All Implemented Interfaces:
Serializable
public class AddDocumentEntityJson extends BaseJson
Give user permissions to a particular workspace file only.
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description AddDocumentEntityJson()
-
Method Summary
Modifier and Type Method Description String
getDescription()
Set description (only for groups)Set<String>
getDocumentGuids()
Set of file guidsString
getEmailMessage()
Text of emailString
getEmailSubject()
Subject line for notification emailDate
getExpirationDate()
Use the expiration field on the permissionsTemplateAddMembersToGroupJson
getGroupMembers()
In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.String
getIdentifier()
Only for workspace groups - adds another identifier to find the group by.boolean
getIsSendMail()
Deprecated.boolean
getIsWatermark()
Deprecated.PermissionsTemplateRequestJson
getPermissionsTemplate()
Permission template to apply to filesPermittedEntityFromUserJson
getPermittedEntity()
Single Entity to addString
getRole()
The new role in the workspace.Set<PermittedEntityFromUserJson>
getRoomEntities()
List<GroupAndMembersJson>
getRoomGroups()
String
getRoomGuid()
Guid of the workspaceInteger
getRoomId()
Id of the workspaceboolean
isIsSendMail()
Flag indicating that a notification email should be sent to recipientsboolean
isIsWatermark()
void
setDescription(String description)
Set description (only for groups)void
setDocumentGuids(Set<String> documentGuids)
Set of file guidsvoid
setEmailMessage(String emailMessage)
Text of emailvoid
setEmailSubject(String emailSubject)
Subject line for notification emailvoid
setExpirationDate(Date expirationDate)
Use the expiration field on the permissionsTemplatevoid
setGroupMembers(AddMembersToGroupJson groupMembers)
In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.void
setIdentifier(String identifier)
Only for workspace groups - adds another identifier to find the group by.void
setIsSendMail(boolean isSendMail)
Flag indicating that a notification email should be sent to recipientsvoid
setIsWatermark(boolean isWatermark)
void
setPermissionsTemplate(PermissionsTemplateRequestJson permissionsTemplate)
Permission template to apply to filesvoid
setPermittedEntity(PermittedEntityFromUserJson permittedEntity)
Single Entity to addvoid
setRole(String role)
The new role in the workspace.void
setRoomEntities(Set<PermittedEntityFromUserJson> roomEntities)
void
setRoomGroups(List<GroupAndMembersJson> roomGroups)
void
setRoomGuid(String roomGuid)
Guid of the workspacevoid
setRoomId(Integer roomId)
Id of the workspaceMethods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
Constructor Details
-
AddDocumentEntityJson
public AddDocumentEntityJson()
-
-
Method Details
-
getDocumentGuids
Set of file guids- Returns:
- Set of file guids
-
setDocumentGuids
Set of file guids- Parameters:
documentGuids
- Set of file guids
-
getGroupMembers
In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.- Returns:
- In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.
-
setGroupMembers
In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.- Parameters:
groupMembers
- In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.
-
getRoomGuid
Guid of the workspace- Returns:
- Guid of the workspace
-
setRoomGuid
Guid of the workspace- Parameters:
roomGuid
- Guid of the workspace
-
getPermittedEntity
Single Entity to add- Returns:
- Single Entity to add
-
setPermittedEntity
Single Entity to add- Parameters:
permittedEntity
- Single Entity to add
-
getIdentifier
Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations. Relevant only if permittedEntity is a roomGroup- Returns:
- Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations. Relevant only if permittedEntity is a roomGroup
-
setIdentifier
Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations. Relevant only if permittedEntity is a roomGroup- Parameters:
identifier
- Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations. Relevant only if permittedEntity is a roomGroup
-
getRoomGroups
-
setRoomGroups
-
getPermissionsTemplate
Permission template to apply to files- Returns:
- Permission template to apply to files
-
setPermissionsTemplate
Permission template to apply to files- Parameters:
permissionsTemplate
- Permission template to apply to files
-
getRole
The new role in the workspace.- Returns:
- The new role in the workspace.
-
setRole
The new role in the workspace.- Parameters:
role
- The new role in the workspace.
-
isIsSendMail
public boolean isIsSendMail()Flag indicating that a notification email should be sent to recipients- Returns:
- Flag indicating that a notification email should be sent to recipients
-
getIsSendMail
Deprecated.Flag indicating that a notification email should be sent to recipients- Returns:
- Flag indicating that a notification email should be sent to recipients
-
setIsSendMail
public void setIsSendMail(boolean isSendMail)Flag indicating that a notification email should be sent to recipients- Parameters:
isSendMail
- Flag indicating that a notification email should be sent to recipients
-
getDescription
Set description (only for groups)- Returns:
- Set description (only for groups)
-
setDescription
Set description (only for groups)- Parameters:
description
- Set description (only for groups)
-
getEmailSubject
Subject line for notification email- Returns:
- Subject line for notification email
-
setEmailSubject
Subject line for notification email- Parameters:
emailSubject
- Subject line for notification email
-
getRoomId
Id of the workspace- Returns:
- Id of the workspace
-
setRoomId
Id of the workspace- Parameters:
roomId
- Id of the workspace
-
getRoomEntities
-
setRoomEntities
-
getEmailMessage
Text of email- Returns:
- Text of email
-
setEmailMessage
Text of email- Parameters:
emailMessage
- Text of email
-
isIsWatermark
public boolean isIsWatermark() -
getIsWatermark
Deprecated. -
setIsWatermark
public void setIsWatermark(boolean isWatermark) -
getExpirationDate
Use the expiration field on the permissionsTemplate- Returns:
- Use the expiration field on the permissionsTemplate
-
setExpirationDate
Use the expiration field on the permissionsTemplate- Parameters:
expirationDate
- Use the expiration field on the permissionsTemplate
-