Interface ParticipantTokenConfiguration.Builder

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

  • Method Details

    • duration

      ParticipantTokenConfiguration.Builder duration(Integer duration)

      Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).

      Parameters:
      duration - Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      ParticipantTokenConfiguration.Builder userId(String userId)

      Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      Parameters:
      userId - Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      ParticipantTokenConfiguration.Builder attributes(Map<String,String> attributes)

      Application-provided attributes to encode into the corresponding participant token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      Parameters:
      attributes - Application-provided attributes to encode into the corresponding participant token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilitiesWithStrings

      ParticipantTokenConfiguration.Builder capabilitiesWithStrings(Collection<String> capabilities)

      Set of capabilities that the user is allowed to perform in the stage.

      Parameters:
      capabilities - Set of capabilities that the user is allowed to perform in the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilitiesWithStrings

      ParticipantTokenConfiguration.Builder capabilitiesWithStrings(String... capabilities)

      Set of capabilities that the user is allowed to perform in the stage.

      Parameters:
      capabilities - Set of capabilities that the user is allowed to perform in the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      ParticipantTokenConfiguration.Builder capabilities(Collection<ParticipantTokenCapability> capabilities)

      Set of capabilities that the user is allowed to perform in the stage.

      Parameters:
      capabilities - Set of capabilities that the user is allowed to perform in the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capabilities

      ParticipantTokenConfiguration.Builder capabilities(ParticipantTokenCapability... capabilities)

      Set of capabilities that the user is allowed to perform in the stage.

      Parameters:
      capabilities - Set of capabilities that the user is allowed to perform in the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.