ConditionalRecipientRuleFilter
in package
implements
ModelInterface, ArrayAccess
ConditionalRecipientRuleFilter Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getModelName() : string
- The original name of the model.
- getOperator() : string|null
- Gets operator
- getRecipientId() : string|null
- Gets recipient_id
- getScope() : string|null
- Gets scope
- getTabId() : string|null
- Gets tab_id
- getTabLabel() : string|null
- Gets tab_label
- getTabType() : string|null
- Gets tab_type
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getValue() : string|null
- Gets value
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setOperator() : $this
- Sets operator
- setRecipientId() : $this
- Sets recipient_id
- setScope() : $this
- Sets scope
- setTabId() : $this
- Sets tab_id
- setTabLabel() : $this
- Sets tab_label
- setTabType() : $this
- Sets tab_type
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setValue() : $this
- Sets value
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['operator' => 'operator', 'recipient_id' => 'recipientId', 'scope' => 'scope', 'tab_id' => 'tabId', 'tab_label' => 'tabLabel', 'tab_type' => 'tabType', 'value' => 'value']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['operator' => 'getOperator', 'recipient_id' => 'getRecipientId', 'scope' => 'getScope', 'tab_id' => 'getTabId', 'tab_label' => 'getTabLabel', 'tab_type' => 'getTabType', 'value' => 'getValue']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['operator' => 'setOperator', 'recipient_id' => 'setRecipientId', 'scope' => 'setScope', 'tab_id' => 'setTabId', 'tab_label' => 'setTabLabel', 'tab_type' => 'setTabType', 'value' => 'setValue']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['operator' => null, 'recipient_id' => null, 'scope' => null, 'tab_id' => null, 'tab_label' => null, 'tab_type' => null, 'value' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'conditionalRecipientRuleFilter'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['operator' => '?string', 'recipient_id' => '?string', 'scope' => '?string', 'tab_id' => '?string', 'tab_label' => '?string', 'tab_type' => '?string', 'value' => '?string']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getOperator()
Gets operator
public
getOperator() : string|null
Return values
string|null —getRecipientId()
Gets recipient_id
public
getRecipientId() : string|null
Return values
string|null —getScope()
Gets scope
public
getScope() : string|null
Return values
string|null —getTabId()
Gets tab_id
public
getTabId() : string|null
Return values
string|null —getTabLabel()
Gets tab_label
public
getTabLabel() : string|null
Return values
string|null —getTabType()
Gets tab_type
public
getTabType() : string|null
Return values
string|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getValue()
Gets value
public
getValue() : string|null
Return values
string|null —listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —setOperator()
Sets operator
public
setOperator(string|null $operator) : $this
Parameters
- $operator : string|null
Return values
$this —setRecipientId()
Sets recipient_id
public
setRecipientId(string|null $recipient_id) : $this
Parameters
- $recipient_id : string|null
-
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
Return values
$this —setScope()
Sets scope
public
setScope(string|null $scope) : $this
Parameters
- $scope : string|null
Return values
$this —setTabId()
Sets tab_id
public
setTabId(string|null $tab_id) : $this
Parameters
- $tab_id : string|null
-
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
Return values
$this —setTabLabel()
Sets tab_label
public
setTabLabel(string|null $tab_label) : $this
Parameters
- $tab_label : string|null
-
The label string associated with the tab.
Return values
$this —setTabType()
Sets tab_type
public
setTabType(string|null $tab_type) : $this
Parameters
- $tab_type : string|null
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setValue()
Sets value
public
setValue(string|null $value) : $this
Parameters
- $value : string|null
-
Specifies the value of the tab.
Return values
$this —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid