Package com.docusign.esign.model

Class Brand

  • All Implemented Interfaces:
    Serializable
    public class Brand
extends Object
implements Serializable
    Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope..
    See Also:
    Serialized Form

    • Constructor Detail

      • Brand

        public Brand()

    • Method Detail

      • brandCompany

        public Brand brandCompany​(String brandCompany)
        brandCompany.
        Returns:
        Brand

      • getBrandCompany

        public String getBrandCompany()
        The name of the company associated with this brand..
        Returns:
        brandCompany

      • setBrandCompany

        public void setBrandCompany​(String brandCompany)
        setBrandCompany.

      • brandId

        public Brand brandId​(String brandId)
        brandId.
        Returns:
        Brand

      • getBrandId

        public String getBrandId()
        The ID used to identify a specific brand in API calls..
        Returns:
        brandId

      • setBrandId

        public void setBrandId​(String brandId)
        setBrandId.

      • brandLanguages

        public Brand brandLanguages​(List<String> brandLanguages)
        brandLanguages.
        Returns:
        Brand

      • addBrandLanguagesItem

        public Brand addBrandLanguagesItem​(String brandLanguagesItem)
        addBrandLanguagesItem.
        Returns:
        Brand

      • getBrandLanguages

        public List<String> getBrandLanguages()
        .
        Returns:
        brandLanguages

      • setBrandLanguages

        public void setBrandLanguages​(List<String> brandLanguages)
        setBrandLanguages.

      • brandName

        public Brand brandName​(String brandName)
        brandName.
        Returns:
        Brand

      • getBrandName

        public String getBrandName()
        The name of the brand..
        Returns:
        brandName

      • setBrandName

        public void setBrandName​(String brandName)
        setBrandName.

      • addColorsItem

        public Brand addColorsItem​(NameValue colorsItem)
        addColorsItem.
        Returns:
        Brand

      • getColors

        public List<NameValue> getColors()
        .
        Returns:
        colors

      • setColors

        public void setColors​(List<NameValue> colors)
        setColors.

      • defaultBrandLanguage

        public Brand defaultBrandLanguage​(String defaultBrandLanguage)
        defaultBrandLanguage.
        Returns:
        Brand

      • getDefaultBrandLanguage

        public String getDefaultBrandLanguage()
        .
        Returns:
        defaultBrandLanguage

      • setDefaultBrandLanguage

        public void setDefaultBrandLanguage​(String defaultBrandLanguage)
        setDefaultBrandLanguage.

      • addEmailContentItem

        public Brand addEmailContentItem​(BrandEmailContent emailContentItem)
        addEmailContentItem.
        Returns:
        Brand

      • setEmailContent

        public void setEmailContent​(List<BrandEmailContent> emailContent)
        setEmailContent.

      • errorDetails

        public Brand errorDetails​(ErrorDetails errorDetails)
        errorDetails.
        Returns:
        Brand

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Array or errors..
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • isOrganizationBrand

        public Brand isOrganizationBrand​(String isOrganizationBrand)
        isOrganizationBrand.
        Returns:
        Brand

      • getIsOrganizationBrand

        public String getIsOrganizationBrand()
        .
        Returns:
        isOrganizationBrand

      • setIsOrganizationBrand

        public void setIsOrganizationBrand​(String isOrganizationBrand)
        setIsOrganizationBrand.

      • isOverridingCompanyName

        public Brand isOverridingCompanyName​(Boolean isOverridingCompanyName)
        isOverridingCompanyName.
        Returns:
        Brand

      • isIsOverridingCompanyName

        public Boolean isIsOverridingCompanyName()
        .
        Returns:
        isOverridingCompanyName

      • setIsOverridingCompanyName

        public void setIsOverridingCompanyName​(Boolean isOverridingCompanyName)
        setIsOverridingCompanyName.

      • isSendingDefault

        public Brand isSendingDefault​(Boolean isSendingDefault)
        isSendingDefault.
        Returns:
        Brand

      • isIsSendingDefault

        public Boolean isIsSendingDefault()
        .
        Returns:
        isSendingDefault

      • setIsSendingDefault

        public void setIsSendingDefault​(Boolean isSendingDefault)
        setIsSendingDefault.

      • isSigningDefault

        public Brand isSigningDefault​(Boolean isSigningDefault)
        isSigningDefault.
        Returns:
        Brand

      • isIsSigningDefault

        public Boolean isIsSigningDefault()
        .
        Returns:
        isSigningDefault

      • setIsSigningDefault

        public void setIsSigningDefault​(Boolean isSigningDefault)
        setIsSigningDefault.

      • landingPages

        public Brand landingPages​(List<NameValue> landingPages)
        landingPages.
        Returns:
        Brand

      • addLandingPagesItem

        public Brand addLandingPagesItem​(NameValue landingPagesItem)
        addLandingPagesItem.
        Returns:
        Brand

      • getLandingPages

        public List<NameValue> getLandingPages()
        .
        Returns:
        landingPages

      • setLandingPages

        public void setLandingPages​(List<NameValue> landingPages)
        setLandingPages.

      • addLinksItem

        public Brand addLinksItem​(BrandLink linksItem)
        addLinksItem.
        Returns:
        Brand

      • setLinks

        public void setLinks​(List<BrandLink> links)
        setLinks.

      • getLogos

        public BrandLogos getLogos()
        The URIs for retrieving the logos that are associated with the brand..
        Returns:
        logos

      • setLogos

        public void setLogos​(BrandLogos logos)
        setLogos.

      • organizationBrandLogo

        public Brand organizationBrandLogo​(String organizationBrandLogo)
        organizationBrandLogo.
        Returns:
        Brand

      • getOrganizationBrandLogo

        public String getOrganizationBrandLogo()
        .
        Returns:
        organizationBrandLogo

      • setOrganizationBrandLogo

        public void setOrganizationBrandLogo​(String organizationBrandLogo)
        setOrganizationBrandLogo.

      • getResources

        public BrandResourceUrls getResources()
        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 `resourceContentType` is `sending`, `signing`, `email`, or `signing_captive`..
        Returns:
        resources

      • setResources

        public void setResources​(BrandResourceUrls resources)
        setResources.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object