nylas/com.nylas.models/ListGrantsQueryParams

ListGrantsQueryParams

public final class ListGrantsQueryParams implements IQueryParams

Class representation of the query parameters for listing grants.

Constructors

public ListGrantsQueryParams ListGrantsQueryParams(Integer limit, Integer offset, String sortBy, String orderBy, Integer since, Integer before, String email, String grantStatus, String ip, AuthProvider provider)

Types

Builder

public final class Builder

Builder for ListGrantsQueryParams.

Properties

before

private final Integer before

Scope grants to a specific point in time by Unix timestamp.

private final String email

Filtering your query based on grant email address (if applicable)

grantStatus

private final String grantStatus

Filtering your query based on grant email status (if applicable)

private final String ip

Filtering your query based on grant IP address

limit

private final Integer limit

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

offset

private final Integer offset

Offset grant results by this number.

orderBy

private final String orderBy

Specify ascending or descending order.

provider

private final AuthProvider provider

Filtering your query based on OAuth provider

since

private final Integer since

Scope grants from a specific point in time by Unix timestamp.

sortBy

private final String sortBy

Sort entries by field name

Functions

convertToMap

public Map<String, String> convertToMap()

Convert the query parameters to a json-formatted map.

getBefore

public final Integer getBefore()

Scope grants to a specific point in time by Unix timestamp.

getEmail

public final String getEmail()

Filtering your query based on grant email address (if applicable)

getGrantStatus

public final String getGrantStatus()

Filtering your query based on grant email status (if applicable)

getIp

public final String getIp()

Filtering your query based on grant IP address

getLimit

public final Integer getLimit()

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

getOffset

public final Integer getOffset()

Offset grant results by this number.

getOrderBy

public final String getOrderBy()

Specify ascending or descending order.

getProvider

public final AuthProvider getProvider()

Filtering your query based on OAuth provider

getSince

public final Integer getSince()

Scope grants from a specific point in time by Unix timestamp.

getSortBy

public final String getSortBy()

Sort entries by field name