Interface GetAccountActivityResponse.Builder

  • Method Details

    • activityId

      A unique identifier that identifies the activity.

      Parameters:
      activityId - A unique identifier that identifies the activity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • title

      A short activity title.

      Parameters:
      title - A short activity title.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      GetAccountActivityResponse.Builder description(String description)

      Provides detailed information about the activity and its expected outcomes.

      Parameters:
      description - Provides detailed information about the activity and its expected outcomes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The current activity status.

      Parameters:
      status - The current activity status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      The current activity status.

      Parameters:
      status - The current activity status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • instructionsUrl

      GetAccountActivityResponse.Builder instructionsUrl(String instructionsUrl)

      The URL resource that provides guidance on activity requirements and completion.

      Parameters:
      instructionsUrl - The URL resource that provides guidance on activity requirements and completion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • reward

      A reward granted upon activity completion.

      Parameters:
      reward - A reward granted upon activity completion.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • reward

      A reward granted upon activity completion.

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

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

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

      GetAccountActivityResponse.Builder estimatedTimeToCompleteInMinutes(Integer estimatedTimeToCompleteInMinutes)

      The estimated time to complete the activity. This is the duration in minutes.

      Parameters:
      estimatedTimeToCompleteInMinutes - The estimated time to complete the activity. This is the duration in minutes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • expiresAt

      The time by which the activity must be completed to receive a reward.

      Parameters:
      expiresAt - The time by which the activity must be completed to receive a reward.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • startedAt

      The timestamp when the activity started. This field appears only for activities in the IN_PROGRESS or COMPLETED states.

      Parameters:
      startedAt - The timestamp when the activity started. This field appears only for activities in the IN_PROGRESS or COMPLETED states.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • completedAt

      GetAccountActivityResponse.Builder completedAt(Instant completedAt)

      The timestamp when the activity is completed. This field appears only for activities in the COMPLETED state.

      Parameters:
      completedAt - The timestamp when the activity is completed. This field appears only for activities in the COMPLETED state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.