ListTemplatesOptions
in package
ListTemplatesOptions Class Doc Comment
Tags
Table of Contents
- $count : string|null
- $count Number of records to return in the cache.
- $created_from_date : string|null
- $created_from_date
- $created_to_date : string|null
- $created_to_date
- $folder_ids : string|null
- $folder_ids A comma separated list of folder ID GUIDs.
- $folder_types : string|null
- $folder_types
- $from_date : string|null
- $from_date Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
- $include : string|null
- $include A comma separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
- $is_deleted_template_only : string|null
- $is_deleted_template_only
- $is_download : string|null
- $is_download
- $modified_from_date : string|null
- $modified_from_date
- $modified_to_date : string|null
- $modified_to_date
- $order : string|null
- $order Sets the direction order used to sort the list. Valid values are: -asc = ascending sort order (a to z) -desc = descending sort order (z to a)
- $order_by : string|null
- $order_by Sets the file attribute used to sort the list. Valid values are: -name: template name -modified: date/time template was last modified. -used: date/time the template was last used.
- $search_fields : string|null
- $search_fields
- $search_text : string|null
- $search_text The search text used to search the names of templates.
- $shared_by_me : string|null
- $shared_by_me If true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.
- $start_position : string|null
- $start_position The starting index for the first template shown in the response. This must be greater than or equal to 0 (zero).
- $template_ids : string|null
- $template_ids
- $to_date : string|null
- $to_date End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.
- $used_from_date : string|null
- $used_from_date Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.
- $used_to_date : string|null
- $used_to_date End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.
- $user_filter : string|null
- $user_filter Sets if the templates shown in the response Valid values are: -owned_by_me: only shows templates the user owns. -shared_with_me: only shows templates that are shared with the user. -all: shows all templates owned or shared with the user.
- $user_id : string|null
- $user_id
- getCount() : string|null
- Gets count
- getCreatedFromDate() : string|null
- Gets created_from_date
- getCreatedToDate() : string|null
- Gets created_to_date
- getFolderIds() : string|null
- Gets folder_ids
- getFolderTypes() : string|null
- Gets folder_types
- getFromDate() : string|null
- Gets from_date
- getInclude() : string|null
- Gets include
- getIsDeletedTemplateOnly() : string|null
- Gets is_deleted_template_only
- getIsDownload() : string|null
- Gets is_download
- getModifiedFromDate() : string|null
- Gets modified_from_date
- getModifiedToDate() : string|null
- Gets modified_to_date
- getOrder() : string|null
- Gets order
- getOrderBy() : string|null
- Gets order_by
- getSearchFields() : string|null
- Gets search_fields
- getSearchText() : string|null
- Gets search_text
- getSharedByMe() : string|null
- Gets shared_by_me
- getStartPosition() : string|null
- Gets start_position
- getTemplateIds() : string|null
- Gets template_ids
- getToDate() : string|null
- Gets to_date
- getUsedFromDate() : string|null
- Gets used_from_date
- getUsedToDate() : string|null
- Gets used_to_date
- getUserFilter() : string|null
- Gets user_filter
- getUserId() : string|null
- Gets user_id
- setCount() : self
- Sets count
- setCreatedFromDate() : self
- Sets created_from_date
- setCreatedToDate() : self
- Sets created_to_date
- setFolderIds() : self
- Sets folder_ids
- setFolderTypes() : self
- Sets folder_types
- setFromDate() : self
- Sets from_date
- setInclude() : self
- Sets include
- setIsDeletedTemplateOnly() : self
- Sets is_deleted_template_only
- setIsDownload() : self
- Sets is_download
- setModifiedFromDate() : self
- Sets modified_from_date
- setModifiedToDate() : self
- Sets modified_to_date
- setOrder() : self
- Sets order
- setOrderBy() : self
- Sets order_by
- setSearchFields() : self
- Sets search_fields
- setSearchText() : self
- Sets search_text
- setSharedByMe() : self
- Sets shared_by_me
- setStartPosition() : self
- Sets start_position
- setTemplateIds() : self
- Sets template_ids
- setToDate() : self
- Sets to_date
- setUsedFromDate() : self
- Sets used_from_date
- setUsedToDate() : self
- Sets used_to_date
- setUserFilter() : self
- Sets user_filter
- setUserId() : self
- Sets user_id
Properties
$count
$count Number of records to return in the cache.
protected
string|null
$count
= null
$created_from_date
$created_from_date
protected
string|null
$created_from_date
= null
$created_to_date
$created_to_date
protected
string|null
$created_to_date
= null
$folder_ids
$folder_ids A comma separated list of folder ID GUIDs.
protected
string|null
$folder_ids
= null
$folder_types
$folder_types
protected
string|null
$folder_types
= null
$from_date
$from_date Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
protected
string|null
$from_date
= null
$include
$include A comma separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
protected
string|null
$include
= null
$is_deleted_template_only
$is_deleted_template_only
protected
string|null
$is_deleted_template_only
= null
$is_download
$is_download
protected
string|null
$is_download
= null
$modified_from_date
$modified_from_date
protected
string|null
$modified_from_date
= null
$modified_to_date
$modified_to_date
protected
string|null
$modified_to_date
= null
$order
$order Sets the direction order used to sort the list. Valid values are: -asc = ascending sort order (a to z) -desc = descending sort order (z to a)
protected
string|null
$order
= null
$order_by
$order_by Sets the file attribute used to sort the list. Valid values are: -name: template name -modified: date/time template was last modified. -used: date/time the template was last used.
protected
string|null
$order_by
= null
$search_fields
$search_fields
protected
string|null
$search_fields
= null
$search_text
$search_text The search text used to search the names of templates.
protected
string|null
$search_text
= null
$shared_by_me
$shared_by_me If true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.
protected
string|null
$shared_by_me
= null
$start_position
$start_position The starting index for the first template shown in the response. This must be greater than or equal to 0 (zero).
protected
string|null
$start_position
= null
$template_ids
$template_ids
protected
string|null
$template_ids
= null
$to_date
$to_date End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.
protected
string|null
$to_date
= null
$used_from_date
$used_from_date Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.
protected
string|null
$used_from_date
= null
$used_to_date
$used_to_date End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.
protected
string|null
$used_to_date
= null
$user_filter
$user_filter Sets if the templates shown in the response Valid values are: -owned_by_me: only shows templates the user owns. -shared_with_me: only shows templates that are shared with the user. -all: shows all templates owned or shared with the user.
protected
string|null
$user_filter
= null
$user_id
$user_id
protected
string|null
$user_id
= null
Methods
getCount()
Gets count
public
getCount() : string|null
Return values
string|null —getCreatedFromDate()
Gets created_from_date
public
getCreatedFromDate() : string|null
Return values
string|null —getCreatedToDate()
Gets created_to_date
public
getCreatedToDate() : string|null
Return values
string|null —getFolderIds()
Gets folder_ids
public
getFolderIds() : string|null
Return values
string|null —getFolderTypes()
Gets folder_types
public
getFolderTypes() : string|null
Return values
string|null —getFromDate()
Gets from_date
public
getFromDate() : string|null
Return values
string|null —getInclude()
Gets include
public
getInclude() : string|null
Return values
string|null —getIsDeletedTemplateOnly()
Gets is_deleted_template_only
public
getIsDeletedTemplateOnly() : string|null
Return values
string|null —getIsDownload()
Gets is_download
public
getIsDownload() : string|null
Return values
string|null —getModifiedFromDate()
Gets modified_from_date
public
getModifiedFromDate() : string|null
Return values
string|null —getModifiedToDate()
Gets modified_to_date
public
getModifiedToDate() : 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 —getSearchFields()
Gets search_fields
public
getSearchFields() : string|null
Return values
string|null —getSearchText()
Gets search_text
public
getSearchText() : string|null
Return values
string|null —getSharedByMe()
Gets shared_by_me
public
getSharedByMe() : string|null
Return values
string|null —getStartPosition()
Gets start_position
public
getStartPosition() : string|null
Return values
string|null —getTemplateIds()
Gets template_ids
public
getTemplateIds() : string|null
Return values
string|null —getToDate()
Gets to_date
public
getToDate() : string|null
Return values
string|null —getUsedFromDate()
Gets used_from_date
public
getUsedFromDate() : string|null
Return values
string|null —getUsedToDate()
Gets used_to_date
public
getUsedToDate() : string|null
Return values
string|null —getUserFilter()
Gets user_filter
public
getUserFilter() : string|null
Return values
string|null —getUserId()
Gets user_id
public
getUserId() : string|null
Return values
string|null —setCount()
Sets count
public
setCount(string|null $count) : self
Parameters
- $count : string|null
-
Number of records to return in the cache.
Return values
self —setCreatedFromDate()
Sets created_from_date
public
setCreatedFromDate(string|null $created_from_date) : self
Parameters
- $created_from_date : string|null
Return values
self —setCreatedToDate()
Sets created_to_date
public
setCreatedToDate(string|null $created_to_date) : self
Parameters
- $created_to_date : string|null
Return values
self —setFolderIds()
Sets folder_ids
public
setFolderIds(string|null $folder_ids) : self
Parameters
- $folder_ids : string|null
-
A comma separated list of folder ID GUIDs.
Return values
self —setFolderTypes()
Sets folder_types
public
setFolderTypes(string|null $folder_types) : self
Parameters
- $folder_types : string|null
Return values
self —setFromDate()
Sets from_date
public
setFromDate(string|null $from_date) : self
Parameters
- $from_date : string|null
-
Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
Return values
self —setInclude()
Sets include
public
setInclude(string|null $include) : self
Parameters
- $include : string|null
-
A comma separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.
Return values
self —setIsDeletedTemplateOnly()
Sets is_deleted_template_only
public
setIsDeletedTemplateOnly(string|null $is_deleted_template_only) : self
Parameters
- $is_deleted_template_only : string|null
Return values
self —setIsDownload()
Sets is_download
public
setIsDownload(string|null $is_download) : self
Parameters
- $is_download : string|null
Return values
self —setModifiedFromDate()
Sets modified_from_date
public
setModifiedFromDate(string|null $modified_from_date) : self
Parameters
- $modified_from_date : string|null
Return values
self —setModifiedToDate()
Sets modified_to_date
public
setModifiedToDate(string|null $modified_to_date) : self
Parameters
- $modified_to_date : string|null
Return values
self —setOrder()
Sets order
public
setOrder(string|null $order) : self
Parameters
- $order : string|null
-
Sets the direction order used to sort the list. Valid values are: -asc = ascending sort order (a to z) -desc = descending sort order (z to a)
Return values
self —setOrderBy()
Sets order_by
public
setOrderBy(string|null $order_by) : self
Parameters
- $order_by : string|null
-
Sets the file attribute used to sort the list. Valid values are: -name: template name -modified: date/time template was last modified. -used: date/time the template was last used.
Return values
self —setSearchFields()
Sets search_fields
public
setSearchFields(string|null $search_fields) : self
Parameters
- $search_fields : string|null
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 names of templates.
Return values
self —setSharedByMe()
Sets shared_by_me
public
setSharedByMe(string|null $shared_by_me) : self
Parameters
- $shared_by_me : string|null
-
If true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.
Return values
self —setStartPosition()
Sets start_position
public
setStartPosition(string|null $start_position) : self
Parameters
- $start_position : string|null
-
The starting index for the first template shown in the response. This must be greater than or equal to 0 (zero).
Return values
self —setTemplateIds()
Sets template_ids
public
setTemplateIds(string|null $template_ids) : self
Parameters
- $template_ids : string|null
Return values
self —setToDate()
Sets to_date
public
setToDate(string|null $to_date) : self
Parameters
- $to_date : string|null
-
End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.
Return values
self —setUsedFromDate()
Sets used_from_date
public
setUsedFromDate(string|null $used_from_date) : self
Parameters
- $used_from_date : string|null
-
Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.
Return values
self —setUsedToDate()
Sets used_to_date
public
setUsedToDate(string|null $used_to_date) : self
Parameters
- $used_to_date : string|null
-
End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.
Return values
self —setUserFilter()
Sets user_filter
public
setUserFilter(string|null $user_filter) : self
Parameters
- $user_filter : string|null
-
Sets if the templates shown in the response Valid values are: -owned_by_me: only shows templates the user owns. -shared_with_me: only shows templates that are shared with the user. -all: shows all templates owned or shared with the user.
Return values
self —setUserId()
Sets user_id
public
setUserId(string|null $user_id) : self
Parameters
- $user_id : string|null