Constructor Detail

Method Detail

• id

   final ChatSession.Builder id(String id)

  Identifier for the ChatKit session.

• id

   final ChatSession.Builder id(JsonField<String> id)

  Sets Builder.id to an arbitrary JSON value.

  You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• chatkitConfiguration

   final ChatSession.Builder chatkitConfiguration(ChatSessionChatKitConfiguration chatkitConfiguration)

  Resolved ChatKit feature configuration for the session.

• chatkitConfiguration

   final ChatSession.Builder chatkitConfiguration(JsonField<ChatSessionChatKitConfiguration> chatkitConfiguration)

  Sets Builder.chatkitConfiguration to an arbitrary JSON value.

  You should usually call Builder.chatkitConfiguration with a well-typed ChatSessionChatKitConfiguration value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• clientSecret

   final ChatSession.Builder clientSecret(String clientSecret)

  Ephemeral client secret that authenticates session requests.

• clientSecret

   final ChatSession.Builder clientSecret(JsonField<String> clientSecret)

  Sets Builder.clientSecret to an arbitrary JSON value.

  You should usually call Builder.clientSecret with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• expiresAt

   final ChatSession.Builder expiresAt(Long expiresAt)

  Unix timestamp (in seconds) for when the session expires.

• expiresAt

   final ChatSession.Builder expiresAt(JsonField<Long> expiresAt)

  Sets Builder.expiresAt to an arbitrary JSON value.

  You should usually call Builder.expiresAt with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• maxRequestsPer1Minute

   final ChatSession.Builder maxRequestsPer1Minute(Long maxRequestsPer1Minute)

  Convenience copy of the per-minute request limit.

• maxRequestsPer1Minute

   final ChatSession.Builder maxRequestsPer1Minute(JsonField<Long> maxRequestsPer1Minute)

  Sets Builder.maxRequestsPer1Minute to an arbitrary JSON value.

  You should usually call Builder.maxRequestsPer1Minute with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• object_

   final ChatSession.Builder object_(JsonValue object_)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("chatkit.session")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• rateLimits

   final ChatSession.Builder rateLimits(ChatSessionRateLimits rateLimits)

  Resolved rate limit values.

• rateLimits

   final ChatSession.Builder rateLimits(JsonField<ChatSessionRateLimits> rateLimits)

  Sets Builder.rateLimits to an arbitrary JSON value.

  You should usually call Builder.rateLimits with a well-typed ChatSessionRateLimits value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• status

   final ChatSession.Builder status(ChatSessionStatus status)

  Current lifecycle state of the session.

• status

   final ChatSession.Builder status(JsonField<ChatSessionStatus> status)

  Sets Builder.status to an arbitrary JSON value.

  You should usually call Builder.status with a well-typed ChatSessionStatus value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• user

   final ChatSession.Builder user(String user)

  User identifier associated with the session.

• user

   final ChatSession.Builder user(JsonField<String> user)

  Sets Builder.user to an arbitrary JSON value.

  You should usually call Builder.user with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• workflow

   final ChatSession.Builder workflow(ChatKitWorkflow workflow)

  Workflow metadata for the session.

• workflow

   final ChatSession.Builder workflow(JsonField<ChatKitWorkflow> workflow)

  Sets Builder.workflow to an arbitrary JSON value.

  You should usually call Builder.workflow with a well-typed ChatKitWorkflow value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final ChatSession.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final ChatSession.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final ChatSession.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final ChatSession.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final ChatSession.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final ChatSession build()

  Returns an immutable instance of ChatSession.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .id()
  .chatkitConfiguration()
  .clientSecret()
  .expiresAt()
  .maxRequestsPer1Minute()
  .rateLimits()
  .status()
  .user()
  .workflow()