nylas/com.nylas.models/ListFoldersQueryParams

ListFoldersQueryParams

public final class ListFoldersQueryParams implements IQueryParams

Class representing the query parameters for listing folders.

Constructors

public ListFoldersQueryParams ListFoldersQueryParams(@Json(name = "limit") Integer limit, @Json(name = "page_token") String pageToken, @Json(name = "parent_id") String parentId, @Json(name = "select") String select, @Json(name = "single_level") Boolean singleLevel, @Json(name = "include_hidden_folders") Boolean includeHiddenFolders)

Types

Builder

public final class Builder

Properties

includeHiddenFolders

private final Boolean includeHiddenFolders

(Microsoft only) When true, Nylas includes hidden folders in its response. Defaults to false.

limit

private final Integer limit

The maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200.

pageToken

private final String pageToken

An identifier that specifies which page of data to return. This value should be taken from the ListResponse.nextCursor response field.

parentId

private final String parentId

(Microsoft and EWS only.) Use the ID of a folder to find all child folders it contains.

select

private String select

Specify fields that you want Nylas to return, as a comma-separated list (for example, select=id,updated_at). This allows you to receive only the portion of object data that you're interested in. You can use select to optimize response size and reduce latency by limiting queries to only the information that you need

singleLevel

private final Boolean singleLevel

(Microsoft only) If true, retrieves folders from a single-level hierarchy only. If false, retrieves folders across a multi-level hierarchy. Defaults to false.

Functions

convertToMap

public Map<String, Object> convertToMap()

Convert the query parameters to a json-formatted map.

getIncludeHiddenFolders

public final Boolean getIncludeHiddenFolders()

(Microsoft only) When true, Nylas includes hidden folders in its response. Defaults to false.

getLimit

public final Integer getLimit()

The maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200.

getPageToken

public final String getPageToken()

An identifier that specifies which page of data to return. This value should be taken from the ListResponse.nextCursor response field.

getParentId

public final String getParentId()

(Microsoft and EWS only.) Use the ID of a folder to find all child folders it contains.

getSelect

public final String getSelect()

getSingleLevel

public final Boolean getSingleLevel()

(Microsoft only) If true, retrieves folders from a single-level hierarchy only. If false, retrieves folders across a multi-level hierarchy. Defaults to false.

setSelect

public final Unit setSelect(String select)