DocuSign CSharp Docs
Public Member Functions | Properties | List of all members
DocuSign.eSign.Model.Brand Class Reference

Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope. More...

Inheritance diagram for DocuSign.eSign.Model.Brand:

Public Member Functions

 Brand (string BrandCompany=default(string), string BrandId=default(string), List< string > BrandLanguages=default(List< string >), string BrandName=default(string), List< NameValue > Colors=default(List< NameValue >), string DefaultBrandLanguage=default(string), List< BrandEmailContent > EmailContent=default(List< BrandEmailContent >), ErrorDetails ErrorDetails=default(ErrorDetails), bool? IsOverridingCompanyName=default(bool?), bool? IsSendingDefault=default(bool?), bool? IsSigningDefault=default(bool?), List< NameValue > LandingPages=default(List< NameValue >), List< BrandLink > Links=default(List< BrandLink >), BrandLogos Logos=default(BrandLogos), BrandResourceUrls Resources=default(BrandResourceUrls))
 Initializes a new instance of the Brand 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 (Brand other)
 Returns true if Brand instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

string BrandCompany [get, set]
 The name of the company associated with this brand. More...
 
string BrandId [get, set]
 The ID used to identify a specific brand in API calls. More...
 
List< string > BrandLanguages [get, set]
 Gets or Sets BrandLanguages More...
 
string BrandName [get, set]
 The name of the brand. More...
 
List< NameValueColors [get, set]
 Gets or Sets Colors More...
 
string DefaultBrandLanguage [get, set]
 Gets or Sets DefaultBrandLanguage More...
 
List< BrandEmailContentEmailContent [get, set]
 Gets or Sets EmailContent More...
 
ErrorDetails ErrorDetails [get, set]
 Array or errors. More...
 
bool IsOverridingCompanyName [get, set]
 Gets or Sets IsOverridingCompanyName More...
 
bool IsSendingDefault [get, set]
 Gets or Sets IsSendingDefault More...
 
bool IsSigningDefault [get, set]
 Gets or Sets IsSigningDefault More...
 
List< NameValueLandingPages [get, set]
 Gets or Sets LandingPages More...
 
List< BrandLinkLinks [get, set]
 Gets or Sets Links More...
 
BrandLogos Logos [get, set]
 The URIs for retrieving the logos that are associated with the brand. More...
 
BrandResourceUrls Resources [get, set]
 An object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience. Note: This object is returned only when the &#x60;resourceContentType&#x60; is &#x60;sending&#x60;, &#x60;signing&#x60;, &#x60;email&#x60;, or &#x60;signing_captive&#x60;. More...
 

Detailed Description

Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.

Constructor & Destructor Documentation

◆ Brand()

DocuSign.eSign.Model.Brand.Brand ( string  BrandCompany = default(string),
string  BrandId = default(string),
List< string >  BrandLanguages = default(List<string>),
string  BrandName = default(string),
List< NameValue Colors = default(List<NameValue>),
string  DefaultBrandLanguage = default(string),
List< BrandEmailContent EmailContent = default(List<BrandEmailContent>),
ErrorDetails  ErrorDetails = default(ErrorDetails),
bool?  IsOverridingCompanyName = default(bool?),
bool?  IsSendingDefault = default(bool?),
bool?  IsSigningDefault = default(bool?),
List< NameValue LandingPages = default(List<NameValue>),
List< BrandLink Links = default(List<BrandLink>),
BrandLogos  Logos = default(BrandLogos),
BrandResourceUrls  Resources = default(BrandResourceUrls) 
)
inline

Initializes a new instance of the Brand class.

Parameters
BrandCompanyThe name of the company associated with this brand..
BrandIdThe ID used to identify a specific brand in API calls..
BrandLanguagesBrandLanguages.
BrandNameThe name of the brand..
ColorsColors.
DefaultBrandLanguageDefaultBrandLanguage.
EmailContentEmailContent.
ErrorDetailsArray or errors..
IsOverridingCompanyNameIsOverridingCompanyName.
IsSendingDefaultIsSendingDefault.
IsSigningDefaultIsSigningDefault.
LandingPagesLandingPages.
LinksLinks.
LogosThe URIs for retrieving the logos that are associated with the brand..
ResourcesAn object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience. Note: This object is returned only when the &#x60;resourceContentType&#x60; is &#x60;sending&#x60;, &#x60;signing&#x60;, &#x60;email&#x60;, or &#x60;signing_captive&#x60;..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.Brand.Equals ( object  obj)
inline

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.Brand.Equals ( Brand  other)
inline

Returns true if Brand instances are equal

Parameters
otherInstance of Brand to be compared
Returns
Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.Brand.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

string DocuSign.eSign.Model.Brand.ToJson ( )
inline

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.Brand.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ BrandCompany

string DocuSign.eSign.Model.Brand.BrandCompany
getset

The name of the company associated with this brand.

The name of the company associated with this brand.

◆ BrandId

string DocuSign.eSign.Model.Brand.BrandId
getset

The ID used to identify a specific brand in API calls.

The ID used to identify a specific brand in API calls.

◆ BrandLanguages

List<string> DocuSign.eSign.Model.Brand.BrandLanguages
getset

Gets or Sets BrandLanguages

◆ BrandName

string DocuSign.eSign.Model.Brand.BrandName
getset

The name of the brand.

The name of the brand.

◆ Colors

List<NameValue> DocuSign.eSign.Model.Brand.Colors
getset

Gets or Sets Colors

◆ DefaultBrandLanguage

string DocuSign.eSign.Model.Brand.DefaultBrandLanguage
getset

Gets or Sets DefaultBrandLanguage

◆ EmailContent

List<BrandEmailContent> DocuSign.eSign.Model.Brand.EmailContent
getset

Gets or Sets EmailContent

◆ ErrorDetails

ErrorDetails DocuSign.eSign.Model.Brand.ErrorDetails
getset

Array or errors.

Array or errors.

◆ IsOverridingCompanyName

bool DocuSign.eSign.Model.Brand.IsOverridingCompanyName
getset

Gets or Sets IsOverridingCompanyName

◆ IsSendingDefault

bool DocuSign.eSign.Model.Brand.IsSendingDefault
getset

Gets or Sets IsSendingDefault

◆ IsSigningDefault

bool DocuSign.eSign.Model.Brand.IsSigningDefault
getset

Gets or Sets IsSigningDefault

◆ LandingPages

List<NameValue> DocuSign.eSign.Model.Brand.LandingPages
getset

Gets or Sets LandingPages

◆ Links

List<BrandLink> DocuSign.eSign.Model.Brand.Links
getset

Gets or Sets Links

◆ Logos

BrandLogos DocuSign.eSign.Model.Brand.Logos
getset

The URIs for retrieving the logos that are associated with the brand.

The URIs for retrieving the logos that are associated with the brand.

◆ Resources

BrandResourceUrls DocuSign.eSign.Model.Brand.Resources
getset

An object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience. Note: This object is returned only when the &#x60;resourceContentType&#x60; is &#x60;sending&#x60;, &#x60;signing&#x60;, &#x60;email&#x60;, or &#x60;signing_captive&#x60;.

An object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience. Note: This object is returned only when the &#x60;resourceContentType&#x60; is &#x60;sending&#x60;, &#x60;signing&#x60;, &#x60;email&#x60;, or &#x60;signing_captive&#x60;.


The documentation for this class was generated from the following file: