Interface BrandingConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<BrandingConfiguration.Builder,BrandingConfiguration>, SdkBuilder<BrandingConfiguration.Builder,BrandingConfiguration>, SdkPojo
Enclosing class:
BrandingConfiguration
@Mutable @NotThreadSafe public static interface BrandingConfiguration.Builder extends SdkPojo, CopyableBuilder<BrandingConfiguration.Builder,BrandingConfiguration>

  • Method Details

    • logo

      BrandingConfiguration.Builder logo(ImageMetadata logo)

      Metadata for the logo image file, including the MIME type, file extension, and upload timestamp.

      Parameters:
      logo - Metadata for the logo image file, including the MIME type, file extension, and upload timestamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logo

      default BrandingConfiguration.Builder logo(Consumer<ImageMetadata.Builder> logo)

      Metadata for the logo image file, including the MIME type, file extension, and upload timestamp.

      This is a convenience method that creates an instance of the ImageMetadata.Builder avoiding the need to create one manually via ImageMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logo(ImageMetadata).

      Parameters:
      logo - a consumer that will call methods on ImageMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • wallpaper

      BrandingConfiguration.Builder wallpaper(ImageMetadata wallpaper)

      Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp.

      Parameters:
      wallpaper - Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • wallpaper

      default BrandingConfiguration.Builder wallpaper(Consumer<ImageMetadata.Builder> wallpaper)

      Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp.

      This is a convenience method that creates an instance of the ImageMetadata.Builder avoiding the need to create one manually via ImageMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to wallpaper(ImageMetadata).

      Parameters:
      wallpaper - a consumer that will call methods on ImageMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • favicon

      BrandingConfiguration.Builder favicon(ImageMetadata favicon)

      Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp.

      Parameters:
      favicon - Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • favicon

      default BrandingConfiguration.Builder favicon(Consumer<ImageMetadata.Builder> favicon)

      Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp.

      This is a convenience method that creates an instance of the ImageMetadata.Builder avoiding the need to create one manually via ImageMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to favicon(ImageMetadata).

      Parameters:
      favicon - a consumer that will call methods on ImageMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • localizedStringsWithStrings

      BrandingConfiguration.Builder localizedStringsWithStrings(Map<String,LocalizedBrandingStrings> localizedStrings)

      A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.

      Parameters:
      localizedStrings - A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • localizedStrings

      BrandingConfiguration.Builder localizedStrings(Map<Locale,LocalizedBrandingStrings> localizedStrings)

      A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.

      Parameters:
      localizedStrings - A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • colorTheme

      BrandingConfiguration.Builder colorTheme(String colorTheme)

      The color theme for components on the web portal.

      Parameters:
      colorTheme - The color theme for components on the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • colorTheme

      BrandingConfiguration.Builder colorTheme(ColorTheme colorTheme)

      The color theme for components on the web portal.

      Parameters:
      colorTheme - The color theme for components on the web portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • termsOfService

      BrandingConfiguration.Builder termsOfService(String termsOfService)

      The terms of service text in Markdown format that users must accept before accessing the portal.

      Parameters:
      termsOfService - The terms of service text in Markdown format that users must accept before accessing the portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.