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
All Methods Instance Methods Concrete Methods Deprecated Methods 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 workspace-
Methods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
-
-
-
Method Detail
-
setDocumentGuids
public void setDocumentGuids(Set<String> documentGuids)
Set of file guids- Parameters:
documentGuids
- Set of file guids
-
getGroupMembers
public AddMembersToGroupJson 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
public void 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.- 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.
-
getPermittedEntity
public PermittedEntityFromUserJson getPermittedEntity()
Single Entity to add- Returns:
- Single Entity to add
-
setPermittedEntity
public void setPermittedEntity(PermittedEntityFromUserJson permittedEntity)
Single Entity to add- Parameters:
permittedEntity
- Single Entity to add
-
getIdentifier
public String 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
public void setIdentifier(String 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- 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
-
getRoomGuid
public String getRoomGuid()
Guid of the workspace- Returns:
- Guid of the workspace
-
setRoomGuid
public void setRoomGuid(String roomGuid)
Guid of the workspace- Parameters:
roomGuid
- Guid of the workspace
-
getPermissionsTemplate
public PermissionsTemplateRequestJson getPermissionsTemplate()
Permission template to apply to files- Returns:
- Permission template to apply to files
-
setPermissionsTemplate
public void setPermissionsTemplate(PermissionsTemplateRequestJson permissionsTemplate)
Permission template to apply to files- Parameters:
permissionsTemplate
- Permission template to apply to files
-
getRole
public String getRole()
The new role in the workspace.- Returns:
- The new role in the workspace.
-
setRole
public void setRole(String role)
The new role in the workspace.- Parameters:
role
- The new role in the workspace.
-
getRoomGroups
public List<GroupAndMembersJson> getRoomGroups()
-
setRoomGroups
public void setRoomGroups(List<GroupAndMembersJson> roomGroups)
-
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 public boolean 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
public String getDescription()
Set description (only for groups)- Returns:
- Set description (only for groups)
-
setDescription
public void setDescription(String description)
Set description (only for groups)- Parameters:
description
- Set description (only for groups)
-
getEmailSubject
public String getEmailSubject()
Subject line for notification email- Returns:
- Subject line for notification email
-
setEmailSubject
public void setEmailSubject(String emailSubject)
Subject line for notification email- Parameters:
emailSubject
- Subject line for notification email
-
getRoomId
public Integer getRoomId()
Id of the workspace- Returns:
- Id of the workspace
-
setRoomId
public void setRoomId(Integer roomId)
Id of the workspace- Parameters:
roomId
- Id of the workspace
-
getRoomEntities
public Set<PermittedEntityFromUserJson> getRoomEntities()
-
setRoomEntities
public void setRoomEntities(Set<PermittedEntityFromUserJson> roomEntities)
-
getEmailMessage
public String getEmailMessage()
Text of email- Returns:
- Text of email
-
setEmailMessage
public void setEmailMessage(String emailMessage)
Text of email- Parameters:
emailMessage
- Text of email
-
isIsWatermark
public boolean isIsWatermark()
-
getIsWatermark
@Deprecated public boolean getIsWatermark()
Deprecated.
-
setIsWatermark
public void setIsWatermark(boolean isWatermark)
-
getExpirationDate
public Date getExpirationDate()
Use the expiration field on the permissionsTemplate- Returns:
- Use the expiration field on the permissionsTemplate
-
setExpirationDate
public void setExpirationDate(Date expirationDate)
Use the expiration field on the permissionsTemplate- Parameters:
expirationDate
- Use the expiration field on the permissionsTemplate
-
-