UpdateFolderByIdRequestBody (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - UpdateFolderByIdRequestBody

All Implemented Interfaces:: Serializable

public class UpdateFolderByIdRequestBody
extends SerializableObject

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UpdateFolderByIdRequestBody.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`UpdateFolderByIdRequestBody.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`canNonOwnersInvite` Specifies if users who are not the owner of the folder can invite new collaborators to the folder.
`protected Boolean`	`canNonOwnersViewCollaborators` Restricts collaborators who are not the owner of this folder from viewing other collaborations on this folder.
`protected List<UpdateFolderByIdRequestBodyCollectionsField>`	`collections` An array of collections to make this folder a member of.
`protected String`	`description` The optional description of this folder.
`protected UpdateFolderByIdRequestBodyFolderUploadEmailField`	`folderUploadEmail`
`protected Boolean`	`isCollaborationRestrictedToEnterprise` Specifies if new invites to this folder are restricted to users within the enterprise.
`protected String`	`name` The optional new name for this folder.
`protected UpdateFolderByIdRequestBodyParentField`	`parent`
`protected UpdateFolderByIdRequestBodySharedLinkField`	`sharedLink`
`protected EnumWrapper<UpdateFolderByIdRequestBodySyncStateField>`	`syncState` Specifies whether a folder should be synced to a user's device or not.
`protected List<String>`	`tags` The tags for this item.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

UpdateFolderByIdRequestBody()

protected UpdateFolderByIdRequestBody(UpdateFolderByIdRequestBody.Builder builder)

Constructors
Modifier	Constructor and Description
	`UpdateFolderByIdRequestBody()`
`protected`	`UpdateFolderByIdRequestBody(UpdateFolderByIdRequestBody.Builder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Boolean`	`getCanNonOwnersInvite()`
`Boolean`	`getCanNonOwnersViewCollaborators()`
`List<UpdateFolderByIdRequestBodyCollectionsField>`	`getCollections()`
`String`	`getDescription()`
`UpdateFolderByIdRequestBodyFolderUploadEmailField`	`getFolderUploadEmail()`
`Boolean`	`getIsCollaborationRestrictedToEnterprise()`
`String`	`getName()`
`UpdateFolderByIdRequestBodyParentField`	`getParent()`
`UpdateFolderByIdRequestBodySharedLinkField`	`getSharedLink()`
`EnumWrapper<UpdateFolderByIdRequestBodySyncStateField>`	`getSyncState()`
`List<String>`	`getTags()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class SerializableObject
getRawData, setRawData

Methods inherited from class NullableFieldTracker
getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
protected String name
```
    The optional new name for this folder.
    The following restrictions to folder names apply: names containing non-printable ASCII characters, forward and backward slashes (`/`, `\`), names with trailing spaces, and names `.` and `..` are not allowed.
    Folder names must be unique within their parent folder. The name check is case-insensitive, so a folder named `New Folder` cannot be created in a parent folder that already contains a folder named `new folder`.
  - description
```
protected String description
```
    The optional description of this folder.
  - syncState
```
protected EnumWrapper<UpdateFolderByIdRequestBodySyncStateField> syncState
```
    Specifies whether a folder should be synced to a user's device or not. This is used by Box Sync (discontinued) and is not used by Box Drive.
  - canNonOwnersInvite
```
protected Boolean canNonOwnersInvite
```
    Specifies if users who are not the owner of the folder can invite new collaborators to the folder.
  - parent
```
protected UpdateFolderByIdRequestBodyParentField parent
```
  - sharedLink
```
protected UpdateFolderByIdRequestBodySharedLinkField sharedLink
```
  - folderUploadEmail
```
protected UpdateFolderByIdRequestBodyFolderUploadEmailField folderUploadEmail
```
  - tags
```
protected List<String> tags
```
    The tags for this item. These tags are shown in the Box web app and mobile apps next to an item.
    To add or remove a tag, retrieve the item's current tags, modify them, and then update this field.
    There is a limit of 100 tags per item, and 10,000 unique tags per enterprise.
  - isCollaborationRestrictedToEnterprise
```
protected Boolean isCollaborationRestrictedToEnterprise
```
    Specifies if new invites to this folder are restricted to users within the enterprise. This does not affect existing collaborations.
  - collections
```
protected List<UpdateFolderByIdRequestBodyCollectionsField> collections
```
    An array of collections to make this folder a member of. Currently we only support the `favorites` collection.
    To get the ID for a collection, use the [List all collections][1] endpoint.
    Passing an empty array `[]` or `null` will remove the folder from all collections.
    [1]: https://developer.box.com/reference/get-collections
  - canNonOwnersViewCollaborators
```
protected Boolean canNonOwnersViewCollaborators
```
    Restricts collaborators who are not the owner of this folder from viewing other collaborations on this folder.
    It also restricts non-owners from inviting new collaborators.
    When setting this field to `false`, it is required to also set `can_non_owners_invite_collaborators` to `false` if it has not already been set.
- Constructor Detail
  - UpdateFolderByIdRequestBody
```
public UpdateFolderByIdRequestBody()
```
  - UpdateFolderByIdRequestBody
```
protected UpdateFolderByIdRequestBody(UpdateFolderByIdRequestBody.Builder builder)
```
- Method Detail
  - getName
```
public String getName()
```
  - getDescription
```
public String getDescription()
```
  - getSyncState
```
public EnumWrapper<UpdateFolderByIdRequestBodySyncStateField> getSyncState()
```
  - getCanNonOwnersInvite
```
public Boolean getCanNonOwnersInvite()
```
  - getParent
```
public UpdateFolderByIdRequestBodyParentField getParent()
```
  - getSharedLink
```
public UpdateFolderByIdRequestBodySharedLinkField getSharedLink()
```
  - getFolderUploadEmail
```
public UpdateFolderByIdRequestBodyFolderUploadEmailField getFolderUploadEmail()
```
  - getTags
```
public List<String> getTags()
```
  - getIsCollaborationRestrictedToEnterprise
```
public Boolean getIsCollaborationRestrictedToEnterprise()
```
  - getCollections
```
public List<UpdateFolderByIdRequestBodyCollectionsField> getCollections()
```
  - getCanNonOwnersViewCollaborators
```
public Boolean getCanNonOwnersViewCollaborators()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class UpdateFolderByIdRequestBody

Nested Class Summary

Field Summary

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

name

description

syncState

canNonOwnersInvite

parent

sharedLink

folderUploadEmail

tags

isCollaborationRestrictedToEnterprise

collections

canNonOwnersViewCollaborators

Constructor Detail

UpdateFolderByIdRequestBody

UpdateFolderByIdRequestBody

Method Detail

getName

getDescription

getSyncState

getCanNonOwnersInvite

getParent

getSharedLink

getFolderUploadEmail

getTags

getIsCollaborationRestrictedToEnterprise

getCollections

getCanNonOwnersViewCollaborators

equals

hashCode

toString