GetSignRequestsQueryParams (Box Java SDK)

Object
- GetSignRequestsQueryParams

public class GetSignRequestsQueryParams
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GetSignRequestsQueryParams.Builder

Field Summary

Fields
Modifier and Type	Field and Description
`Long`	`limit` The maximum number of items to return per page.
`String`	`marker` Defines the position marker at which to begin returning results.
`List<String>`	`senders` A list of sender emails to filter the signature requests by sender.
`Boolean`	`sharedRequests` If set to `true`, only includes requests that user is not an owner, but user is a collaborator.

Constructor Summary

Constructors
Modifier Constructor and Description

GetSignRequestsQueryParams()

protected GetSignRequestsQueryParams(GetSignRequestsQueryParams.Builder builder)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

Long getLimit()

String getMarker()

List<String> getSenders()

Boolean getSharedRequests()
- Methods inherited from class Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - marker
```
public String marker
```
    Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
    This requires `usemarker` to be set to `true`.
  - limit
```
public Long limit
```
    The maximum number of items to return per page.
  - senders
```
public List<String> senders
```
    A list of sender emails to filter the signature requests by sender. If provided, `shared_requests` must be set to `true`.
  - sharedRequests
```
public Boolean sharedRequests
```
    If set to `true`, only includes requests that user is not an owner, but user is a collaborator. Collaborator access is determined by the user access level of the sign files of the request. Default is `false`. Must be set to `true` if `senders` are provided.
- Constructor Detail
  - GetSignRequestsQueryParams
```
public GetSignRequestsQueryParams()
```
  - GetSignRequestsQueryParams
```
protected GetSignRequestsQueryParams(GetSignRequestsQueryParams.Builder builder)
```
- Method Detail
  - getMarker
```
public String getMarker()
```
  - getLimit
```
public Long getLimit()
```
  - getSenders
```
public List<String> getSenders()
```
  - getSharedRequests
```
public Boolean getSharedRequests()
```