ListItemsOptions
in package
ListItemsOptions Class Doc Comment
Tags
Table of Contents
- $from_date : string|null
- $from_date Only return items on or after this date. If no value is provided, the default search is the previous 30 days.
- $include_items : string|null
- $include_items
- $owner_email : string|null
- $owner_email The email of the folder owner.
- $owner_name : string|null
- $owner_name The name of the folder owner.
- $search_text : string|null
- $search_text The search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject.
- $start_position : string|null
- $start_position The position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0.
- $status : string|null
- $status The current status of the envelope. If no value is provided, the default search is all/any status.
- $to_date : string|null
- $to_date Only return items up to this date. If no value is provided, the default search is to the current date.
- getFromDate() : string|null
- Gets from_date
- getIncludeItems() : string|null
- Gets include_items
- getOwnerEmail() : string|null
- Gets owner_email
- getOwnerName() : string|null
- Gets owner_name
- getSearchText() : string|null
- Gets search_text
- getStartPosition() : string|null
- Gets start_position
- getStatus() : string|null
- Gets status
- getToDate() : string|null
- Gets to_date
- setFromDate() : self
- Sets from_date
- setIncludeItems() : self
- Sets include_items
- setOwnerEmail() : self
- Sets owner_email
- setOwnerName() : self
- Sets owner_name
- setSearchText() : self
- Sets search_text
- setStartPosition() : self
- Sets start_position
- setStatus() : self
- Sets status
- setToDate() : self
- Sets to_date
Properties
$from_date
$from_date Only return items on or after this date. If no value is provided, the default search is the previous 30 days.
protected
string|null
$from_date
= null
$include_items
$include_items
protected
string|null
$include_items
= null
$owner_email
$owner_email The email of the folder owner.
protected
string|null
$owner_email
= null
$owner_name
$owner_name The name of the folder owner.
protected
string|null
$owner_name
= null
$search_text
$search_text The search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject.
protected
string|null
$search_text
= null
$start_position
$start_position The position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0.
protected
string|null
$start_position
= null
$status
$status The current status of the envelope. If no value is provided, the default search is all/any status.
protected
string|null
$status
= null
$to_date
$to_date Only return items up to this date. If no value is provided, the default search is to the current date.
protected
string|null
$to_date
= null
Methods
getFromDate()
Gets from_date
public
getFromDate() : string|null
Return values
string|null —getIncludeItems()
Gets include_items
public
getIncludeItems() : string|null
Return values
string|null —getOwnerEmail()
Gets owner_email
public
getOwnerEmail() : string|null
Return values
string|null —getOwnerName()
Gets owner_name
public
getOwnerName() : string|null
Return values
string|null —getSearchText()
Gets search_text
public
getSearchText() : string|null
Return values
string|null —getStartPosition()
Gets start_position
public
getStartPosition() : string|null
Return values
string|null —getStatus()
Gets status
public
getStatus() : string|null
Return values
string|null —getToDate()
Gets to_date
public
getToDate() : string|null
Return values
string|null —setFromDate()
Sets from_date
public
setFromDate(string|null $from_date) : self
Parameters
- $from_date : string|null
-
Only return items on or after this date. If no value is provided, the default search is the previous 30 days.
Return values
self —setIncludeItems()
Sets include_items
public
setIncludeItems(string|null $include_items) : self
Parameters
- $include_items : string|null
Return values
self —setOwnerEmail()
Sets owner_email
public
setOwnerEmail(string|null $owner_email) : self
Parameters
- $owner_email : string|null
-
The email of the folder owner.
Return values
self —setOwnerName()
Sets owner_name
public
setOwnerName(string|null $owner_name) : self
Parameters
- $owner_name : string|null
-
The name of the folder owner.
Return values
self —setSearchText()
Sets search_text
public
setSearchText(string|null $search_text) : self
Parameters
- $search_text : string|null
-
The search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject.
Return values
self —setStartPosition()
Sets start_position
public
setStartPosition(string|null $start_position) : self
Parameters
- $start_position : string|null
-
The position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0.
Return values
self —setStatus()
Sets status
public
setStatus(string|null $status) : self
Parameters
- $status : string|null
-
The current status of the envelope. If no value is provided, the default search is all/any status.
Return values
self —setToDate()
Sets to_date
public
setToDate(string|null $to_date) : self
Parameters
- $to_date : string|null
-
Only return items up to this date. If no value is provided, the default search is to the current date.