The `connectCustomConfiguration` object describes how Connect is configured for your account. More...
Public Member Functions | |
| ConnectCustomConfiguration (string AllowEnvelopePublish=default(string), string AllowSalesforcePublish=default(string), string AllUsers=default(string), string AllUsersExcept=default(string), string ConfigurationType=default(string), string ConnectId=default(string), string DeliveryMode=default(string), string DisabledBy=default(string), string EnableLog=default(string), List< string > EnvelopeEvents=default(List< string >), ConnectEventData EventData=default(ConnectEventData), List< string > Events=default(List< string >), string ExternalFolderId=default(string), string ExternalFolderLabel=default(string), List< string > GroupIds=default(List< string >), string IncludeCertificateOfCompletion=default(string), string IncludeCertSoapHeader=default(string), string IncludeDocumentFields=default(string), string IncludeDocuments=default(string), string IncludeEnvelopeVoidReason=default(string), string IncludeHMAC=default(string), string IncludeOAuth=default(string), string IncludeSenderAccountasCustomField=default(string), string IncludeTimeZoneInformation=default(string), string IntegratorManaged=default(string), string Name=default(string), string Password=default(string), List< string > RecipientEvents=default(List< string >), string RequireMutualTls=default(string), string RequiresAcknowledgement=default(string), string SalesforceApiVersion=default(string), string SalesforceAuthcode=default(string), string SalesforceCallBackUrl=default(string), string SalesforceDocumentsAsContentFiles=default(string), string SenderOverride=default(string), List< string > SenderSelectableItems=default(List< string >), List< ConnectSalesforceObject > SfObjects=default(List< ConnectSalesforceObject >), string SignMessageWithX509Certificate=default(string), string SoapNamespace=default(string), string UrlToPublishTo=default(string), List< string > UserIds=default(List< string >), string UserName=default(string), string UseSoapInterface=default(string)) | |
| Initializes a new instance of the ConnectCustomConfiguration 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 (ConnectCustomConfiguration other) |
| Returns true if ConnectCustomConfiguration instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
| IEnumerable< ValidationResult > | Validate (ValidationContext validationContext) |
Properties | |
| string | AllowEnvelopePublish [get, set] |
| When set to true, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information. More... | |
| string | AllowSalesforcePublish [get, set] |
| Gets or Sets AllowSalesforcePublish More... | |
| string | AllUsers [get, set] |
| When set to true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. More... | |
| string | AllUsersExcept [get, set] |
| Gets or Sets AllUsersExcept More... | |
| string | ConfigurationType [get, set] |
| If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce. More... | |
| string | ConnectId [get, set] |
| Specifies the DocuSign generated ID for the Connect configuration. More... | |
| string | DeliveryMode [get, set] |
| Gets or Sets DeliveryMode More... | |
| string | DisabledBy [get, set] |
| Gets or Sets DisabledBy More... | |
| string | EnableLog [get, set] |
| This turns Connect logging on or off. When set to true, logging is turned on. More... | |
| List< string > | EnvelopeEvents [get, set] |
| A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided. More... | |
| ConnectEventData | EventData [get, set] |
| Allows you to specify the format of the information the Connect webhooks returns. For more information, see Connect webhooks with JSON notifications More... | |
| List< string > | Events [get, set] |
| Gets or Sets Events More... | |
| string | ExternalFolderId [get, set] |
| Gets or Sets ExternalFolderId More... | |
| string | ExternalFolderLabel [get, set] |
| Gets or Sets ExternalFolderLabel More... | |
| List< string > | GroupIds [get, set] |
| Gets or Sets GroupIds More... | |
| string | IncludeCertificateOfCompletion [get, set] |
| When set to true, the Connect Service includes the Certificate of Completion with completed envelopes. More... | |
| string | IncludeCertSoapHeader [get, set] |
| Gets or Sets IncludeCertSoapHeader More... | |
| string | IncludeDocumentFields [get, set] |
| When set to true, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API. More... | |
| string | IncludeDocuments [get, set] |
| When set to true, Connect will send the PDF document along with the update XML. More... | |
| string | IncludeEnvelopeVoidReason [get, set] |
| When set to true, Connect will include the voidedReason for voided envelopes. More... | |
| string | IncludeHMAC [get, set] |
| Gets or Sets IncludeHMAC More... | |
| string | IncludeOAuth [get, set] |
| Gets or Sets IncludeOAuth More... | |
| string | IncludeSenderAccountasCustomField [get, set] |
| When set to true, Connect will include the sender account as Custom Field in the data. More... | |
| string | IncludeTimeZoneInformation [get, set] |
| When set to true, Connect will include the envelope time zone information. More... | |
| string | IntegratorManaged [get, set] |
| Gets or Sets IntegratorManaged More... | |
| string | Name [get, set] |
| The name of the Connect configuration. The name helps identify the configuration in the list. More... | |
| string | Password [get, set] |
| Gets or Sets Password More... | |
| List< string > | RecipientEvents [get, set] |
| A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. More... | |
| string | RequireMutualTls [get, set] |
| Gets or Sets RequireMutualTls More... | |
| string | RequiresAcknowledgement [get, set] |
| When set to true, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information. More... | |
| string | SalesforceApiVersion [get, set] |
| Gets or Sets SalesforceApiVersion More... | |
| string | SalesforceAuthcode [get, set] |
| Gets or Sets SalesforceAuthcode More... | |
| string | SalesforceCallBackUrl [get, set] |
| Gets or Sets SalesforceCallBackUrl More... | |
| string | SalesforceDocumentsAsContentFiles [get, set] |
| Gets or Sets SalesforceDocumentsAsContentFiles More... | |
| string | SenderOverride [get, set] |
| Gets or Sets SenderOverride More... | |
| List< string > | SenderSelectableItems [get, set] |
| Gets or Sets SenderSelectableItems More... | |
| List< ConnectSalesforceObject > | SfObjects [get, set] |
| Gets or Sets SfObjects More... | |
| string | SignMessageWithX509Certificate [get, set] |
| When set to true, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL. More... | |
| string | SoapNamespace [get, set] |
| The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true. More... | |
| string | UrlToPublishTo [get, set] |
| This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address. More... | |
| List< string > | UserIds [get, set] |
| A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s. More... | |
| string | UserName [get, set] |
| Gets or Sets UserName More... | |
| string | UseSoapInterface [get, set] |
| When set to true, indicates that the `urlToPublishTo` property contains a SOAP endpoint. More... | |
Detailed Description
The `connectCustomConfiguration` object describes how Connect is configured for your account.
Constructor & Destructor Documentation
◆ ConnectCustomConfiguration()
|
inline |
Initializes a new instance of the ConnectCustomConfiguration class.
- Parameters
-
AllowEnvelopePublish When set to true, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information.. AllowSalesforcePublish AllowSalesforcePublish. AllUsers When set to true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.. AllUsersExcept AllUsersExcept. ConfigurationType If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.. ConnectId Specifies the DocuSign generated ID for the Connect configuration. . DeliveryMode DeliveryMode. DisabledBy DisabledBy. EnableLog This turns Connect logging on or off. When set to true, logging is turned on.. EnvelopeEvents A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided.. EventData Allows you to specify the format of the information the Connect webhooks returns. For more information, see Connect webhooks with JSON notifications. Events Events. ExternalFolderId ExternalFolderId. ExternalFolderLabel ExternalFolderLabel. GroupIds GroupIds. IncludeCertificateOfCompletion When set to true, the Connect Service includes the Certificate of Completion with completed envelopes. . IncludeCertSoapHeader IncludeCertSoapHeader. IncludeDocumentFields When set to true, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API. . IncludeDocuments When set to true, Connect will send the PDF document along with the update XML.. IncludeEnvelopeVoidReason When set to true, Connect will include the voidedReason for voided envelopes.. IncludeHMAC IncludeHMAC. IncludeOAuth IncludeOAuth. IncludeSenderAccountasCustomField When set to true, Connect will include the sender account as Custom Field in the data.. IncludeTimeZoneInformation When set to true, Connect will include the envelope time zone information.. IntegratorManaged IntegratorManaged. Name The name of the Connect configuration. The name helps identify the configuration in the list.. Password Password. RecipientEvents A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.. RequireMutualTls RequireMutualTls. RequiresAcknowledgement When set to true, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information.. SalesforceApiVersion SalesforceApiVersion. SalesforceAuthcode SalesforceAuthcode. SalesforceCallBackUrl SalesforceCallBackUrl. SalesforceDocumentsAsContentFiles SalesforceDocumentsAsContentFiles. SenderOverride SenderOverride. SenderSelectableItems SenderSelectableItems. SfObjects SfObjects. SignMessageWithX509Certificate When set to true, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL.. SoapNamespace The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true.. UrlToPublishTo This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address.. UserIds A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s.. UserName UserName. UseSoapInterface When set to true, indicates that the `urlToPublishTo` property contains a SOAP endpoint..
Member Function Documentation
◆ Equals() [1/2]
|
inline |
Returns true if objects are equal
- Parameters
-
obj Object to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
Returns true if ConnectCustomConfiguration instances are equal
- Parameters
-
other Instance of ConnectCustomConfiguration to be compared
- Returns
- Boolean
◆ GetHashCode()
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ToJson()
|
inline |
Returns the JSON string presentation of the object
- Returns
- JSON string presentation of the object
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ AllowEnvelopePublish
|
getset |
When set to true, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information.
When set to true, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information.
◆ AllowSalesforcePublish
|
getset |
Gets or Sets AllowSalesforcePublish
◆ AllUsers
|
getset |
When set to true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.
When set to true, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.
◆ AllUsersExcept
|
getset |
Gets or Sets AllUsersExcept
◆ ConfigurationType
|
getset |
If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.
If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.
◆ ConnectId
|
getset |
◆ DeliveryMode
|
getset |
Gets or Sets DeliveryMode
◆ DisabledBy
|
getset |
Gets or Sets DisabledBy
◆ EnableLog
|
getset |
This turns Connect logging on or off. When set to true, logging is turned on.
This turns Connect logging on or off. When set to true, logging is turned on.
◆ EnvelopeEvents
|
getset |
A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided.
A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided.
◆ EventData
|
getset |
Allows you to specify the format of the information the Connect webhooks returns. For more information, see Connect webhooks with JSON notifications
Allows you to specify the format of the information the Connect webhooks returns. For more information, see Connect webhooks with JSON notifications
◆ Events
|
getset |
Gets or Sets Events
◆ ExternalFolderId
|
getset |
Gets or Sets ExternalFolderId
◆ ExternalFolderLabel
|
getset |
Gets or Sets ExternalFolderLabel
◆ GroupIds
|
getset |
Gets or Sets GroupIds
◆ IncludeCertificateOfCompletion
|
getset |
When set to true, the Connect Service includes the Certificate of Completion with completed envelopes.
When set to true, the Connect Service includes the Certificate of Completion with completed envelopes.
◆ IncludeCertSoapHeader
|
getset |
Gets or Sets IncludeCertSoapHeader
◆ IncludeDocumentFields
|
getset |
When set to true, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API.
When set to true, the Document Fields associated with envelope documents are included in the data. Document Fields are optional custom name-value pairs added to documents using the API.
◆ IncludeDocuments
|
getset |
When set to true, Connect will send the PDF document along with the update XML.
When set to true, Connect will send the PDF document along with the update XML.
◆ IncludeEnvelopeVoidReason
|
getset |
When set to true, Connect will include the voidedReason for voided envelopes.
When set to true, Connect will include the voidedReason for voided envelopes.
◆ IncludeHMAC
|
getset |
Gets or Sets IncludeHMAC
◆ IncludeOAuth
|
getset |
Gets or Sets IncludeOAuth
◆ IncludeSenderAccountasCustomField
|
getset |
When set to true, Connect will include the sender account as Custom Field in the data.
When set to true, Connect will include the sender account as Custom Field in the data.
◆ IncludeTimeZoneInformation
|
getset |
When set to true, Connect will include the envelope time zone information.
When set to true, Connect will include the envelope time zone information.
◆ IntegratorManaged
|
getset |
Gets or Sets IntegratorManaged
◆ Name
|
getset |
The name of the Connect configuration. The name helps identify the configuration in the list.
The name of the Connect configuration. The name helps identify the configuration in the list.
◆ Password
|
getset |
Gets or Sets Password
◆ RecipientEvents
|
getset |
A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.
A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.
◆ RequireMutualTls
|
getset |
Gets or Sets RequireMutualTls
◆ RequiresAcknowledgement
|
getset |
When set to true, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information.
When set to true, and a publication message fails to be acknowledged, the message goes back into the queue and the system will retry delivery after a successful acknowledgement is received. If the delivery fails a second time, the message is not returned to the queue for sending until Connect receives a successful acknowledgement and it has been at least 24 hours since the previous retry. There is a maximum of ten retries Alternately, you can use Republish Connect Information to manually republish the envelope information.
◆ SalesforceApiVersion
|
getset |
Gets or Sets SalesforceApiVersion
◆ SalesforceAuthcode
|
getset |
Gets or Sets SalesforceAuthcode
◆ SalesforceCallBackUrl
|
getset |
Gets or Sets SalesforceCallBackUrl
◆ SalesforceDocumentsAsContentFiles
|
getset |
Gets or Sets SalesforceDocumentsAsContentFiles
◆ SenderOverride
|
getset |
Gets or Sets SenderOverride
◆ SenderSelectableItems
|
getset |
Gets or Sets SenderSelectableItems
◆ SfObjects
|
getset |
Gets or Sets SfObjects
◆ SignMessageWithX509Certificate
|
getset |
When set to true, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL.
When set to true, Connect messages are signed with an X509 certificate. This provides support for 2-way SSL.
◆ SoapNamespace
|
getset |
The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true.
The namespace of the SOAP interface. The namespace value must be set if useSoapInterface is set to true.
◆ UrlToPublishTo
|
getset |
This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address.
This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address.
◆ UserIds
|
getset |
A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s.
A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s.
◆ UserName
|
getset |
Gets or Sets UserName
◆ UseSoapInterface
|
getset |
When set to true, indicates that the `urlToPublishTo` property contains a SOAP endpoint.
When set to true, indicates that the `urlToPublishTo` property contains a SOAP endpoint.
The documentation for this class was generated from the following file:
- sdk/src/DocuSign.eSign/Model/ConnectCustomConfiguration.cs
