public class AddDocumentEntityJson extends BaseJson
Constructor and Description |
---|
AddDocumentEntityJson() |
Modifier and Type | Method and Description |
---|---|
String |
getDescription()
Set description (only for groups)
|
Set<String> |
getDocumentGuids()
Set of file guids
|
String |
getEmailMessage()
Text of email
|
String |
getEmailSubject()
Subject line for notification email
|
Date |
getExpirationDate()
Use the expiration field on the permissionsTemplate
|
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.
|
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 files
|
PermittedEntityFromUserJson |
getPermittedEntity()
Single Entity to add
|
String |
getRole()
The new role in the workspace.
|
Set<PermittedEntityFromUserJson> |
getRoomEntities() |
List<GroupAndMembersJson> |
getRoomGroups() |
String |
getRoomGuid()
Guid of the workspace
|
Integer |
getRoomId()
Id of the workspace
|
boolean |
isIsSendMail()
Flag indicating that a notification email should be sent to recipients
|
boolean |
isIsWatermark() |
void |
setDescription(String description)
Set description (only for groups)
|
void |
setDocumentGuids(Set<String> documentGuids)
Set of file guids
|
void |
setEmailMessage(String emailMessage)
Text of email
|
void |
setEmailSubject(String emailSubject)
Subject line for notification email
|
void |
setExpirationDate(Date expirationDate)
Use the expiration field on the permissionsTemplate
|
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.
|
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 recipients
|
void |
setIsWatermark(boolean isWatermark) |
void |
setPermissionsTemplate(PermissionsTemplateRequestJson permissionsTemplate)
Permission template to apply to files
|
void |
setPermittedEntity(PermittedEntityFromUserJson permittedEntity)
Single Entity to add
|
void |
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 workspace
|
void |
setRoomId(Integer roomId)
Id of the workspace
|
getObjType, setObjType, toString
public AddMembersToGroupJson getGroupMembers()
public void setGroupMembers(AddMembersToGroupJson groupMembers)
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.public void setDocumentGuids(Set<String> documentGuids)
documentGuids
- Set of file guidspublic PermittedEntityFromUserJson getPermittedEntity()
public void setPermittedEntity(PermittedEntityFromUserJson permittedEntity)
permittedEntity
- Single Entity to addpublic String getRoomGuid()
public void setRoomGuid(String roomGuid)
roomGuid
- Guid of the workspacepublic String getIdentifier()
public void setIdentifier(String identifier)
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 roomGrouppublic String getRole()
public void setRole(String role)
role
- The new role in the workspace.public PermissionsTemplateRequestJson getPermissionsTemplate()
public void setPermissionsTemplate(PermissionsTemplateRequestJson permissionsTemplate)
permissionsTemplate
- Permission template to apply to filespublic List<GroupAndMembersJson> getRoomGroups()
public void setRoomGroups(List<GroupAndMembersJson> roomGroups)
public boolean isIsSendMail()
@Deprecated public boolean getIsSendMail()
public void setIsSendMail(boolean isSendMail)
isSendMail
- Flag indicating that a notification email should be
sent to recipientspublic String getDescription()
public void setDescription(String description)
description
- Set description (only for groups)public String getEmailSubject()
public void setEmailSubject(String emailSubject)
emailSubject
- Subject line for notification emailpublic Integer getRoomId()
public void setRoomId(Integer roomId)
roomId
- Id of the workspacepublic Set<PermittedEntityFromUserJson> getRoomEntities()
public void setRoomEntities(Set<PermittedEntityFromUserJson> roomEntities)
public String getEmailMessage()
public void setEmailMessage(String emailMessage)
emailMessage
- Text of emailpublic boolean isIsWatermark()
@Deprecated public boolean getIsWatermark()
public void setIsWatermark(boolean isWatermark)
public Date getExpirationDate()
public void setExpirationDate(Date expirationDate)
expirationDate
- Use the expiration field on the
permissionsTemplateCopyright © 2019. All rights reserved.