Interface UserSettings.Builder

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

  • Method Details

    • additionalEncryptionContext

      UserSettings.Builder additionalEncryptionContext(Map<String,String> additionalEncryptionContext)

      The additional encryption context of the user settings.

      Parameters:
      additionalEncryptionContext - The additional encryption context of the user settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associatedPortalArns

      UserSettings.Builder associatedPortalArns(Collection<String> associatedPortalArns)

      A list of web portal ARNs that this user settings is associated with.

      Parameters:
      associatedPortalArns - A list of web portal ARNs that this user settings is associated with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associatedPortalArns

      UserSettings.Builder associatedPortalArns(String... associatedPortalArns)

      A list of web portal ARNs that this user settings is associated with.

      Parameters:
      associatedPortalArns - A list of web portal ARNs that this user settings is associated with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cookieSynchronizationConfiguration

      UserSettings.Builder cookieSynchronizationConfiguration(CookieSynchronizationConfiguration cookieSynchronizationConfiguration)

      The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

      Parameters:
      cookieSynchronizationConfiguration - The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cookieSynchronizationConfiguration

      default UserSettings.Builder cookieSynchronizationConfiguration(Consumer<CookieSynchronizationConfiguration.Builder> cookieSynchronizationConfiguration)

      The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

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

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

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

    • copyAllowed

      UserSettings.Builder copyAllowed(String copyAllowed)

      Specifies whether the user can copy text from the streaming session to the local device.

      Parameters:
      copyAllowed - Specifies whether the user can copy text from the streaming session to the local device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • copyAllowed

      UserSettings.Builder copyAllowed(EnabledType copyAllowed)

      Specifies whether the user can copy text from the streaming session to the local device.

      Parameters:
      copyAllowed - Specifies whether the user can copy text from the streaming session to the local device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customerManagedKey

      UserSettings.Builder customerManagedKey(String customerManagedKey)

      The customer managed key used to encrypt sensitive information in the user settings.

      Parameters:
      customerManagedKey - The customer managed key used to encrypt sensitive information in the user settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deepLinkAllowed

      UserSettings.Builder deepLinkAllowed(String deepLinkAllowed)

      Specifies whether the user can use deep links that open automatically when connecting to a session.

      Parameters:
      deepLinkAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deepLinkAllowed

      UserSettings.Builder deepLinkAllowed(EnabledType deepLinkAllowed)

      Specifies whether the user can use deep links that open automatically when connecting to a session.

      Parameters:
      deepLinkAllowed - Specifies whether the user can use deep links that open automatically when connecting to a session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • disconnectTimeoutInMinutes

      UserSettings.Builder disconnectTimeoutInMinutes(Integer disconnectTimeoutInMinutes)

      The amount of time that a streaming session remains active after users disconnect.

      Parameters:
      disconnectTimeoutInMinutes - The amount of time that a streaming session remains active after users disconnect.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • downloadAllowed

      UserSettings.Builder downloadAllowed(String downloadAllowed)

      Specifies whether the user can download files from the streaming session to the local device.

      Parameters:
      downloadAllowed - Specifies whether the user can download files from the streaming session to the local device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • downloadAllowed

      UserSettings.Builder downloadAllowed(EnabledType downloadAllowed)

      Specifies whether the user can download files from the streaming session to the local device.

      Parameters:
      downloadAllowed - Specifies whether the user can download files from the streaming session to the local device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • idleDisconnectTimeoutInMinutes

      UserSettings.Builder idleDisconnectTimeoutInMinutes(Integer idleDisconnectTimeoutInMinutes)

      The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

      Parameters:
      idleDisconnectTimeoutInMinutes - The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pasteAllowed

      UserSettings.Builder pasteAllowed(String pasteAllowed)

      Specifies whether the user can paste text from the local device to the streaming session.

      Parameters:
      pasteAllowed - Specifies whether the user can paste text from the local device to the streaming session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pasteAllowed

      UserSettings.Builder pasteAllowed(EnabledType pasteAllowed)

      Specifies whether the user can paste text from the local device to the streaming session.

      Parameters:
      pasteAllowed - Specifies whether the user can paste text from the local device to the streaming session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • printAllowed

      UserSettings.Builder printAllowed(String printAllowed)

      Specifies whether the user can print to the local device.

      Parameters:
      printAllowed - Specifies whether the user can print to the local device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • printAllowed

      UserSettings.Builder printAllowed(EnabledType printAllowed)

      Specifies whether the user can print to the local device.

      Parameters:
      printAllowed - Specifies whether the user can print to the local device.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • toolbarConfiguration

      UserSettings.Builder toolbarConfiguration(ToolbarConfiguration toolbarConfiguration)

      The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.

      Parameters:
      toolbarConfiguration - The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • toolbarConfiguration

      default UserSettings.Builder toolbarConfiguration(Consumer<ToolbarConfiguration.Builder> toolbarConfiguration)

      The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.

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

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

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

    • uploadAllowed

      UserSettings.Builder uploadAllowed(String uploadAllowed)

      Specifies whether the user can upload files from the local device to the streaming session.

      Parameters:
      uploadAllowed - Specifies whether the user can upload files from the local device to the streaming session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • uploadAllowed

      UserSettings.Builder uploadAllowed(EnabledType uploadAllowed)

      Specifies whether the user can upload files from the local device to the streaming session.

      Parameters:
      uploadAllowed - Specifies whether the user can upload files from the local device to the streaming session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userSettingsArn

      UserSettings.Builder userSettingsArn(String userSettingsArn)

      The ARN of the user settings.

      Parameters:
      userSettingsArn - The ARN of the user settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.