Interface SecurityGroupSettings.Builder

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

  • Method Details

    • alwaysReauthenticate

      SecurityGroupSettings.Builder alwaysReauthenticate(Boolean alwaysReauthenticate)

      Requires users to reauthenticate every time they return to the application, providing an additional layer of security.

      Parameters:
      alwaysReauthenticate - Requires users to reauthenticate every time they return to the application, providing an additional layer of security.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • atakPackageValues

      SecurityGroupSettings.Builder atakPackageValues(Collection<String> atakPackageValues)

      Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.

      Parameters:
      atakPackageValues - Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • atakPackageValues

      SecurityGroupSettings.Builder atakPackageValues(String... atakPackageValues)

      Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.

      Parameters:
      atakPackageValues - Configuration values for ATAK (Android Team Awareness Kit) package integration, when ATAK is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • calling

      SecurityGroupSettings.Builder calling(CallingSettings calling)

      The calling feature permissions and settings that control what types of calls users can initiate and participate in.

      Parameters:
      calling - The calling feature permissions and settings that control what types of calls users can initiate and participate in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • calling

      default SecurityGroupSettings.Builder calling(Consumer<CallingSettings.Builder> calling)

      The calling feature permissions and settings that control what types of calls users can initiate and participate in.

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

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

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

    • checkForUpdates

      SecurityGroupSettings.Builder checkForUpdates(Boolean checkForUpdates)

      Enables automatic checking for Wickr client updates to ensure users stay current with the latest version.

      Parameters:
      checkForUpdates - Enables automatic checking for Wickr client updates to ensure users stay current with the latest version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableAtak

      SecurityGroupSettings.Builder enableAtak(Boolean enableAtak)

      Enables ATAK (Android Team Awareness Kit) integration for tactical communication and situational awareness.

      Parameters:
      enableAtak - Enables ATAK (Android Team Awareness Kit) integration for tactical communication and situational awareness.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableCrashReports

      SecurityGroupSettings.Builder enableCrashReports(Boolean enableCrashReports)

      Allow users to report crashes.

      Parameters:
      enableCrashReports - Allow users to report crashes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableFileDownload

      SecurityGroupSettings.Builder enableFileDownload(Boolean enableFileDownload)

      Specifies whether users can download files from messages to their devices.

      Parameters:
      enableFileDownload - Specifies whether users can download files from messages to their devices.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableGuestFederation

      SecurityGroupSettings.Builder enableGuestFederation(Boolean enableGuestFederation)

      Allows users to communicate with guest users from other Wickr networks and federated external networks.

      Parameters:
      enableGuestFederation - Allows users to communicate with guest users from other Wickr networks and federated external networks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableNotificationPreview

      SecurityGroupSettings.Builder enableNotificationPreview(Boolean enableNotificationPreview)

      Enables message preview text in push notifications, allowing users to see message content before opening the app.

      Parameters:
      enableNotificationPreview - Enables message preview text in push notifications, allowing users to see message content before opening the app.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableOpenAccessOption

      SecurityGroupSettings.Builder enableOpenAccessOption(Boolean enableOpenAccessOption)

      Allow users to avoid censorship when they are geo-blocked or have network limitations.

      Parameters:
      enableOpenAccessOption - Allow users to avoid censorship when they are geo-blocked or have network limitations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableRestrictedGlobalFederation

      SecurityGroupSettings.Builder enableRestrictedGlobalFederation(Boolean enableRestrictedGlobalFederation)

      Enables restricted global federation, limiting external communication to only specified permitted networks.

      Parameters:
      enableRestrictedGlobalFederation - Enables restricted global federation, limiting external communication to only specified permitted networks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filesEnabled

      SecurityGroupSettings.Builder filesEnabled(Boolean filesEnabled)

      Enables file sharing capabilities, allowing users to send and receive files in conversations.

      Parameters:
      filesEnabled - Enables file sharing capabilities, allowing users to send and receive files in conversations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • forceDeviceLockout

      SecurityGroupSettings.Builder forceDeviceLockout(Integer forceDeviceLockout)

      Defines the number of failed login attempts before data stored on the device is reset. Should be less than lockoutThreshold.

      Parameters:
      forceDeviceLockout - Defines the number of failed login attempts before data stored on the device is reset. Should be less than lockoutThreshold.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • forceOpenAccess

      SecurityGroupSettings.Builder forceOpenAccess(Boolean forceOpenAccess)

      Automatically enable and enforce Wickr open access on all devices. Valid only if enableOpenAccessOption settings is enabled.

      Parameters:
      forceOpenAccess - Automatically enable and enforce Wickr open access on all devices. Valid only if enableOpenAccessOption settings is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • forceReadReceipts

      SecurityGroupSettings.Builder forceReadReceipts(Boolean forceReadReceipts)

      Allow user approved bots to read messages in rooms without using a slash command.

      Parameters:
      forceReadReceipts - Allow user approved bots to read messages in rooms without using a slash command.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • globalFederation

      SecurityGroupSettings.Builder globalFederation(Boolean globalFederation)

      Allows users to communicate with users on other Wickr instances (Wickr Enterprise) outside the current network.

      Parameters:
      globalFederation - Allows users to communicate with users on other Wickr instances (Wickr Enterprise) outside the current network.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isAtoEnabled

      SecurityGroupSettings.Builder isAtoEnabled(Boolean isAtoEnabled)

      Enforces a two-factor authentication when a user adds a new device to their account.

      Parameters:
      isAtoEnabled - Enforces a two-factor authentication when a user adds a new device to their account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isLinkPreviewEnabled

      SecurityGroupSettings.Builder isLinkPreviewEnabled(Boolean isLinkPreviewEnabled)

      Enables automatic preview of links shared in messages, showing webpage thumbnails and descriptions.

      Parameters:
      isLinkPreviewEnabled - Enables automatic preview of links shared in messages, showing webpage thumbnails and descriptions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locationAllowMaps

      SecurityGroupSettings.Builder locationAllowMaps(Boolean locationAllowMaps)

      Allows map integration in location sharing, enabling users to view shared locations on interactive maps. Only allowed when location setting is enabled.

      Parameters:
      locationAllowMaps - Allows map integration in location sharing, enabling users to view shared locations on interactive maps. Only allowed when location setting is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locationEnabled

      SecurityGroupSettings.Builder locationEnabled(Boolean locationEnabled)

      Enables location sharing features, allowing users to share their current location with others.

      Parameters:
      locationEnabled - Enables location sharing features, allowing users to share their current location with others.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxAutoDownloadSize

      SecurityGroupSettings.Builder maxAutoDownloadSize(Long maxAutoDownloadSize)

      The maximum file size in bytes that will be automatically downloaded without user confirmation. Only allowed if fileDownload is enabled. Valid Values [512000 (low_quality), 7340032 (high_quality) ]

      Parameters:
      maxAutoDownloadSize - The maximum file size in bytes that will be automatically downloaded without user confirmation. Only allowed if fileDownload is enabled. Valid Values [512000 (low_quality), 7340032 (high_quality) ]
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxBor

      SecurityGroupSettings.Builder maxBor(Integer maxBor)

      The maximum burn-on-read (BOR) time in seconds, which determines how long messages remain visible before auto-deletion after being read.

      Parameters:
      maxBor - The maximum burn-on-read (BOR) time in seconds, which determines how long messages remain visible before auto-deletion after being read.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxTtl

      SecurityGroupSettings.Builder maxTtl(Long maxTtl)

      The maximum time-to-live (TTL) in seconds for messages, after which they will be automatically deleted from all devices.

      Parameters:
      maxTtl - The maximum time-to-live (TTL) in seconds for messages, after which they will be automatically deleted from all devices.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messageForwardingEnabled

      SecurityGroupSettings.Builder messageForwardingEnabled(Boolean messageForwardingEnabled)

      Enables message forwarding, allowing users to forward messages from one conversation to another.

      Parameters:
      messageForwardingEnabled - Enables message forwarding, allowing users to forward messages from one conversation to another.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • passwordRequirements

      SecurityGroupSettings.Builder passwordRequirements(PasswordRequirements passwordRequirements)

      The password complexity requirements that users must follow when creating or changing passwords.

      Parameters:
      passwordRequirements - The password complexity requirements that users must follow when creating or changing passwords.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • passwordRequirements

      default SecurityGroupSettings.Builder passwordRequirements(Consumer<PasswordRequirements.Builder> passwordRequirements)

      The password complexity requirements that users must follow when creating or changing passwords.

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

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

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

    • presenceEnabled

      SecurityGroupSettings.Builder presenceEnabled(Boolean presenceEnabled)

      Enables presence indicators that show whether users are online, away, or offline.

      Parameters:
      presenceEnabled - Enables presence indicators that show whether users are online, away, or offline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • quickResponses

      SecurityGroupSettings.Builder quickResponses(Collection<String> quickResponses)

      A list of pre-defined quick response message templates that users can send with a single tap.

      Parameters:
      quickResponses - A list of pre-defined quick response message templates that users can send with a single tap.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • quickResponses

      SecurityGroupSettings.Builder quickResponses(String... quickResponses)

      A list of pre-defined quick response message templates that users can send with a single tap.

      Parameters:
      quickResponses - A list of pre-defined quick response message templates that users can send with a single tap.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • showMasterRecoveryKey

      SecurityGroupSettings.Builder showMasterRecoveryKey(Boolean showMasterRecoveryKey)

      Users will get a master recovery key that can be used to securely sign in to their Wickr account without having access to their primary device for authentication. Available in SSO enabled network.

      Parameters:
      showMasterRecoveryKey - Users will get a master recovery key that can be used to securely sign in to their Wickr account without having access to their primary device for authentication. Available in SSO enabled network.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shredder

      SecurityGroupSettings.Builder shredder(ShredderSettings shredder)

      The message shredder configuration that controls secure deletion of messages and files from devices.

      Parameters:
      shredder - The message shredder configuration that controls secure deletion of messages and files from devices.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shredder

      default SecurityGroupSettings.Builder shredder(Consumer<ShredderSettings.Builder> shredder)

      The message shredder configuration that controls secure deletion of messages and files from devices.

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

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

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

    • ssoMaxIdleMinutes

      SecurityGroupSettings.Builder ssoMaxIdleMinutes(Integer ssoMaxIdleMinutes)

      The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network.

      Parameters:
      ssoMaxIdleMinutes - The duration for which users SSO session remains inactive before automatically logging them out for security. Available in SSO enabled network.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • federationMode

      SecurityGroupSettings.Builder federationMode(Integer federationMode)

      The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted).

      Parameters:
      federationMode - The local federation mode controlling how users can communicate with other networks. Values: 0 (none), 1 (federated), 2 (restricted).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lockoutThreshold

      SecurityGroupSettings.Builder lockoutThreshold(Integer lockoutThreshold)

      The number of failed password attempts before a user account is locked out.

      Parameters:
      lockoutThreshold - The number of failed password attempts before a user account is locked out.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permittedNetworks

      SecurityGroupSettings.Builder permittedNetworks(Collection<String> permittedNetworks)

      A list of network IDs that are permitted for local federation when federation mode is set to restricted.

      Parameters:
      permittedNetworks - A list of network IDs that are permitted for local federation when federation mode is set to restricted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permittedNetworks

      SecurityGroupSettings.Builder permittedNetworks(String... permittedNetworks)

      A list of network IDs that are permitted for local federation when federation mode is set to restricted.

      Parameters:
      permittedNetworks - A list of network IDs that are permitted for local federation when federation mode is set to restricted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permittedWickrAwsNetworks

      SecurityGroupSettings.Builder permittedWickrAwsNetworks(Collection<WickrAwsNetworks> permittedWickrAwsNetworks)

      A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.

      Parameters:
      permittedWickrAwsNetworks - A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permittedWickrAwsNetworks

      SecurityGroupSettings.Builder permittedWickrAwsNetworks(WickrAwsNetworks... permittedWickrAwsNetworks)

      A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.

      Parameters:
      permittedWickrAwsNetworks - A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permittedWickrAwsNetworks

      SecurityGroupSettings.Builder permittedWickrAwsNetworks(Consumer<WickrAwsNetworks.Builder>... permittedWickrAwsNetworks)

      A list of permitted Wickr networks for global federation, restricting communication to specific approved networks.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to permittedWickrAwsNetworks(List<WickrAwsNetworks>).

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

    • permittedWickrEnterpriseNetworks

      SecurityGroupSettings.Builder permittedWickrEnterpriseNetworks(Collection<PermittedWickrEnterpriseNetwork> permittedWickrEnterpriseNetworks)

      A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.

      Parameters:
      permittedWickrEnterpriseNetworks - A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permittedWickrEnterpriseNetworks

      SecurityGroupSettings.Builder permittedWickrEnterpriseNetworks(PermittedWickrEnterpriseNetwork... permittedWickrEnterpriseNetworks)

      A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.

      Parameters:
      permittedWickrEnterpriseNetworks - A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permittedWickrEnterpriseNetworks

      SecurityGroupSettings.Builder permittedWickrEnterpriseNetworks(Consumer<PermittedWickrEnterpriseNetwork.Builder>... permittedWickrEnterpriseNetworks)

      A list of permitted Wickr Enterprise networks for global federation, restricting communication to specific approved networks.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to permittedWickrEnterpriseNetworks(List<PermittedWickrEnterpriseNetwork>).

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