A complex element containing the following information: templateId: Unique identifier of the template. If this is not provided, DocuSign will generate a value. name: Name of the template. Maximum length: 100 characters. shared: When set to true, the template is shared with the Everyone group in the account. If false, the template is only shared with the Administrator group. password: Password, if the template is locked. description: Description of the template. Maximum Length: 500 characters. pageCount: Number of document pages in the template. folderName: The name of the folder the template is located in. folderId: The ID for the folder. owner: The userName, email, userId, userType, and userStatus for the template owner.
More...
|
| EnvelopeTemplateDefinition (string Created=default(string), string Description=default(string), string FolderId=default(string), string FolderName=default(string), string FolderUri=default(string), string LastModified=default(string), UserInfo LastModifiedBy=default(UserInfo), string Name=default(string), string NewPassword=default(string), UserInfo Owner=default(UserInfo), int? PageCount=default(int?), string ParentFolderUri=default(string), string Password=default(string), string Shared=default(string), string TemplateId=default(string), string Uri=default(string)) |
| Initializes a new instance of the EnvelopeTemplateDefinition class. More...
|
|
override string | ToString () |
| Returns the string presentation of the object More...
|
|
string | ToJson () |
| Returns the JSON string presentation of the object More...
|
|
override bool | Equals (object obj) |
| Returns true if objects are equal More...
|
|
bool | Equals (EnvelopeTemplateDefinition other) |
| Returns true if EnvelopeTemplateDefinition instances are equal More...
|
|
override int | GetHashCode () |
| Gets the hash code More...
|
|
IEnumerable< ValidationResult > | Validate (ValidationContext validationContext) |
|
|
string | Created [get, set] |
|
string | Description [get, set] |
|
string | FolderId [get, set] |
| The ID for the folder. More...
|
|
string | FolderName [get, set] |
| The name of the folder in which the template is located. More...
|
|
string | FolderUri [get, set] |
| The URI of the folder. More...
|
|
string | LastModified [get, set] |
|
UserInfo | LastModifiedBy [get, set] |
| Gets or Sets LastModifiedBy More...
|
|
string | Name [get, set] |
|
string | NewPassword [get, set] |
|
UserInfo | Owner [get, set] |
| Gets or Sets Owner More...
|
|
int | PageCount [get, set] |
| An integer value specifying the number of document pages in the template. Omit this property if not submitting a page count. More...
|
|
string | ParentFolderUri [get, set] |
|
string | Password [get, set] |
|
string | Shared [get, set] |
| When set to true, this custom tab is shared. More...
|
|
string | TemplateId [get, set] |
| The unique identifier of the template. If this is not provided, DocuSign will generate a value. More...
|
|
string | Uri [get, set] |
|
A complex element containing the following information: templateId: Unique identifier of the template. If this is not provided, DocuSign will generate a value. name: Name of the template. Maximum length: 100 characters. shared: When set to true, the template is shared with the Everyone group in the account. If false, the template is only shared with the Administrator group. password: Password, if the template is locked. description: Description of the template. Maximum Length: 500 characters. pageCount: Number of document pages in the template. folderName: The name of the folder the template is located in. folderId: The ID for the folder. owner: The userName, email, userId, userType, and userStatus for the template owner.
◆ EnvelopeTemplateDefinition()
DocuSign.eSign.Model.EnvelopeTemplateDefinition.EnvelopeTemplateDefinition |
( |
string |
Created = default(string) , |
|
|
string |
Description = default(string) , |
|
|
string |
FolderId = default(string) , |
|
|
string |
FolderName = default(string) , |
|
|
string |
FolderUri = default(string) , |
|
|
string |
LastModified = default(string) , |
|
|
UserInfo |
LastModifiedBy = default(UserInfo) , |
|
|
string |
Name = default(string) , |
|
|
string |
NewPassword = default(string) , |
|
|
UserInfo |
Owner = default(UserInfo) , |
|
|
int? |
PageCount = default(int?) , |
|
|
string |
ParentFolderUri = default(string) , |
|
|
string |
Password = default(string) , |
|
|
string |
Shared = default(string) , |
|
|
string |
TemplateId = default(string) , |
|
|
string |
Uri = default(string) |
|
) |
| |
|
inline |
Initializes a new instance of the EnvelopeTemplateDefinition class.
- Parameters
-
Created | . |
Description | . |
FolderId | The ID for the folder.. |
FolderName | The name of the folder in which the template is located.. |
FolderUri | The URI of the folder.. |
LastModified | . |
LastModifiedBy | LastModifiedBy. |
Name | . |
NewPassword | . |
Owner | Owner. |
PageCount | An integer value specifying the number of document pages in the template. Omit this property if not submitting a page count.. |
ParentFolderUri | . |
Password | . |
Shared | When set to true, this custom tab is shared.. |
TemplateId | The unique identifier of the template. If this is not provided, DocuSign will generate a value. . |
Uri | . |
◆ Equals() [1/2]
override bool DocuSign.eSign.Model.EnvelopeTemplateDefinition.Equals |
( |
object |
obj | ) |
|
|
inline |
Returns true if objects are equal
- Parameters
-
- Returns
- Boolean
◆ Equals() [2/2]
◆ GetHashCode()
override int DocuSign.eSign.Model.EnvelopeTemplateDefinition.GetHashCode |
( |
| ) |
|
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ToJson()
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.ToJson |
( |
| ) |
|
|
inline |
Returns the JSON string presentation of the object
- Returns
- JSON string presentation of the object
◆ ToString()
override string DocuSign.eSign.Model.EnvelopeTemplateDefinition.ToString |
( |
| ) |
|
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
◆ Created
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.Created |
|
getset |
◆ Description
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.Description |
|
getset |
◆ FolderId
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.FolderId |
|
getset |
The ID for the folder.
The ID for the folder.
◆ FolderName
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.FolderName |
|
getset |
The name of the folder in which the template is located.
The name of the folder in which the template is located.
◆ FolderUri
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.FolderUri |
|
getset |
The URI of the folder.
The URI of the folder.
◆ LastModified
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.LastModified |
|
getset |
◆ LastModifiedBy
UserInfo DocuSign.eSign.Model.EnvelopeTemplateDefinition.LastModifiedBy |
|
getset |
Gets or Sets LastModifiedBy
◆ Name
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.Name |
|
getset |
◆ NewPassword
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.NewPassword |
|
getset |
◆ Owner
UserInfo DocuSign.eSign.Model.EnvelopeTemplateDefinition.Owner |
|
getset |
◆ PageCount
int DocuSign.eSign.Model.EnvelopeTemplateDefinition.PageCount |
|
getset |
An integer value specifying the number of document pages in the template. Omit this property if not submitting a page count.
An integer value specifying the number of document pages in the template. Omit this property if not submitting a page count.
◆ ParentFolderUri
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.ParentFolderUri |
|
getset |
◆ Password
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.Password |
|
getset |
◆ Shared
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.Shared |
|
getset |
When set to true, this custom tab is shared.
When set to true, this custom tab is shared.
◆ TemplateId
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.TemplateId |
|
getset |
The unique identifier of the template. If this is not provided, DocuSign will generate a value.
The unique identifier of the template. If this is not provided, DocuSign will generate a value.
◆ Uri
string DocuSign.eSign.Model.EnvelopeTemplateDefinition.Uri |
|
getset |
The documentation for this class was generated from the following file:
- sdk/src/DocuSign.eSign/Model/EnvelopeTemplateDefinition.cs