SearchOptions
in package
SearchOptions Class Doc Comment
Tags
Table of Contents
- $all : string|null
- $all Specifies that all envelopes that match the criteria are returned.
- $count : string|null
- $count Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.
- $from_date : string|null
- $from_date Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.
- $include_recipients : string|null
- $include_recipients When set to **true**, the recipient information is returned in the response.
- $order : string|null
- $order Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.
- $order_by : string|null
- $order_by Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.
- $start_position : string|null
- $start_position Specifies the the starting location in the result set of the items that are returned.
- $to_date : string|null
- $to_date Specifies the end of the date range to return.
- getAll() : string|null
- Gets all
- getCount() : string|null
- Gets count
- getFromDate() : string|null
- Gets from_date
- getIncludeRecipients() : string|null
- Gets include_recipients
- getOrder() : string|null
- Gets order
- getOrderBy() : string|null
- Gets order_by
- getStartPosition() : string|null
- Gets start_position
- getToDate() : string|null
- Gets to_date
- setAll() : self
- Sets all
- setCount() : self
- Sets count
- setFromDate() : self
- Sets from_date
- setIncludeRecipients() : self
- Sets include_recipients
- setOrder() : self
- Sets order
- setOrderBy() : self
- Sets order_by
- setStartPosition() : self
- Sets start_position
- setToDate() : self
- Sets to_date
Properties
$all
$all Specifies that all envelopes that match the criteria are returned.
protected
string|null
$all
= null
$count
$count Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.
protected
string|null
$count
= null
$from_date
$from_date Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.
protected
string|null
$from_date
= null
$include_recipients
$include_recipients When set to **true**, the recipient information is returned in the response.
protected
string|null
$include_recipients
= null
$order
$order Specifies the order in which the list is returned. Valid values are: `asc` for ascending order, and `desc` for descending order.
protected
string|null
$order
= null
$order_by
$order_by Specifies the property used to sort the list. Valid values are: `action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.
protected
string|null
$order_by
= null
$start_position
$start_position Specifies the the starting location in the result set of the items that are returned.
protected
string|null
$start_position
= null
$to_date
$to_date Specifies the end of the date range to return.
protected
string|null
$to_date
= null
Methods
getAll()
Gets all
public
getAll() : string|null
Return values
string|null —getCount()
Gets count
public
getCount() : string|null
Return values
string|null —getFromDate()
Gets from_date
public
getFromDate() : string|null
Return values
string|null —getIncludeRecipients()
Gets include_recipients
public
getIncludeRecipients() : string|null
Return values
string|null —getOrder()
Gets order
public
getOrder() : string|null
Return values
string|null —getOrderBy()
Gets order_by
public
getOrderBy() : string|null
Return values
string|null —getStartPosition()
Gets start_position
public
getStartPosition() : string|null
Return values
string|null —getToDate()
Gets to_date
public
getToDate() : string|null
Return values
string|null —setAll()
Sets all
public
setAll(string|null $all) : self
Parameters
- $all : string|null
-
Specifies that all envelopes that match the criteria are returned.
Return values
self —setCount()
Sets count
public
setCount(string|null $count) : self
Parameters
- $count : string|null
-
Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.
Return values
self —setFromDate()
Sets from_date
public
setFromDate(string|null $from_date) : self
Parameters
- $from_date : string|null
-
Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.
Return values
self —setIncludeRecipients()
Sets include_recipients
public
setIncludeRecipients(string|null $include_recipients) : self
Parameters
- $include_recipients : string|null
-
When set to true, the recipient information is returned in the response.
Return values
self —setOrder()
Sets order
public
setOrder(string|null $order) : self
Parameters
- $order : string|null
-
Specifies the order in which the list is returned. Valid values are:
ascfor ascending order, anddescfor descending order.
Return values
self —setOrderBy()
Sets order_by
public
setOrderBy(string|null $order_by) : self
Parameters
- $order_by : string|null
-
Specifies the property used to sort the list. Valid values are:
action_required,created,completed,sent,signer_list,status, orsubject.
Return values
self —setStartPosition()
Sets start_position
public
setStartPosition(string|null $start_position) : self
Parameters
- $start_position : string|null
-
Specifies the the starting location in the result set of the items that are returned.
Return values
self —setToDate()
Sets to_date
public
setToDate(string|null $to_date) : self
Parameters
- $to_date : string|null
-
Specifies the end of the date range to return.