Constructor Detail

Method Detail

• userId

   final UserListMessagesParams.Builder userId(String userId)

• userId

   final UserListMessagesParams.Builder userId(Optional<String> userId)

  Alias for calling Builder.userId with userId.orElse(null).

• after

   final UserListMessagesParams.Builder after(String after)

  The cursor to fetch entries after.

• after

   final UserListMessagesParams.Builder after(Optional<String> after)

  Alias for calling Builder.after with after.orElse(null).

• before

   final UserListMessagesParams.Builder before(String before)

  The cursor to fetch entries before.

• before

   final UserListMessagesParams.Builder before(Optional<String> before)

  Alias for calling Builder.before with before.orElse(null).

• channelId

   final UserListMessagesParams.Builder channelId(String channelId)

  Limits the results to items with the corresponding channel ID.

• channelId

   final UserListMessagesParams.Builder channelId(Optional<String> channelId)

  Alias for calling Builder.channelId with channelId.orElse(null).

• engagementStatus

   final UserListMessagesParams.Builder engagementStatus(List<UserListMessagesParams.EngagementStatus> engagementStatus)

  Limits the results to messages with the given engagement status.

• engagementStatus

   final UserListMessagesParams.Builder engagementStatus(Optional<List<UserListMessagesParams.EngagementStatus>> engagementStatus)

  Alias for calling Builder.engagementStatus with engagementStatus.orElse(null).

• addEngagementStatus

   final UserListMessagesParams.Builder addEngagementStatus(UserListMessagesParams.EngagementStatus engagementStatus)

  Adds a single EngagementStatus to Builder.engagementStatus.

• insertedAt

   final UserListMessagesParams.Builder insertedAt(UserListMessagesParams.InsertedAt insertedAt)

• insertedAt

   final UserListMessagesParams.Builder insertedAt(Optional<UserListMessagesParams.InsertedAt> insertedAt)

  Alias for calling Builder.insertedAt with insertedAt.orElse(null).

• messageIds

   final UserListMessagesParams.Builder messageIds(List<String> messageIds)

  Limits the results to only the message IDs given (max 50). Note: when using this option, the results will be subject to any other filters applied to the query.

• messageIds

   final UserListMessagesParams.Builder messageIds(Optional<List<String>> messageIds)

  Alias for calling Builder.messageIds with messageIds.orElse(null).

• addMessageId

   final UserListMessagesParams.Builder addMessageId(String messageId)

  Adds a single String to messageIds.

• pageSize

   final UserListMessagesParams.Builder pageSize(Long pageSize)

  The number of items per page.

• pageSize

   final UserListMessagesParams.Builder pageSize(Long pageSize)

  Alias for Builder.pageSize.

  This unboxed primitive overload exists for backwards compatibility.

• pageSize

   final UserListMessagesParams.Builder pageSize(Optional<Long> pageSize)

  Alias for calling Builder.pageSize with pageSize.orElse(null).

• source

   final UserListMessagesParams.Builder source(String source)

  Limits the results to messages triggered by the given workflow key.

• source

   final UserListMessagesParams.Builder source(Optional<String> source)

  Alias for calling Builder.source with source.orElse(null).

• status

   final UserListMessagesParams.Builder status(List<UserListMessagesParams.Status> status)

  Limits the results to messages with the given delivery status.

• status

   final UserListMessagesParams.Builder status(Optional<List<UserListMessagesParams.Status>> status)

  Alias for calling Builder.status with status.orElse(null).

• addStatus

   final UserListMessagesParams.Builder addStatus(UserListMessagesParams.Status status)

  Adds a single Status to Builder.status.

• tenant

   final UserListMessagesParams.Builder tenant(String tenant)

  Limits the results to items with the corresponding tenant.

• tenant

   final UserListMessagesParams.Builder tenant(Optional<String> tenant)

  Alias for calling Builder.tenant with tenant.orElse(null).

• triggerData

   final UserListMessagesParams.Builder triggerData(String triggerData)

  Limits the results to only messages that were generated with the given data. See /api-reference/overview/trigger-data-filtering for more information.

• triggerData

   final UserListMessagesParams.Builder triggerData(Optional<String> triggerData)

  Alias for calling Builder.triggerData with triggerData.orElse(null).

• workflowCategories

   final UserListMessagesParams.Builder workflowCategories(List<String> workflowCategories)

  Limits the results to messages related to any of the provided categories.

• workflowCategories

   final UserListMessagesParams.Builder workflowCategories(Optional<List<String>> workflowCategories)

  Alias for calling Builder.workflowCategories with workflowCategories.orElse(null).

• addWorkflowCategory

   final UserListMessagesParams.Builder addWorkflowCategory(String workflowCategory)

  Adds a single String to workflowCategories.

• workflowRecipientRunId

   final UserListMessagesParams.Builder workflowRecipientRunId(String workflowRecipientRunId)

  Limits the results to messages for a specific recipient's workflow run.

• workflowRecipientRunId

   final UserListMessagesParams.Builder workflowRecipientRunId(Optional<String> workflowRecipientRunId)

  Alias for calling Builder.workflowRecipientRunId with workflowRecipientRunId.orElse(null).

• workflowRunId

   final UserListMessagesParams.Builder workflowRunId(String workflowRunId)

  Limits the results to messages associated with the top-level workflow run ID returned by the workflow trigger request.

• workflowRunId

   final UserListMessagesParams.Builder workflowRunId(Optional<String> workflowRunId)

  Alias for calling Builder.workflowRunId with workflowRunId.orElse(null).

• additionalHeaders

   final UserListMessagesParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final UserListMessagesParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final UserListMessagesParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final UserListMessagesParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final UserListMessagesParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final UserListMessagesParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final UserListMessagesParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final UserListMessagesParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final UserListMessagesParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final UserListMessagesParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final UserListMessagesParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final UserListMessagesParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final UserListMessagesParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final UserListMessagesParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final UserListMessagesParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final UserListMessagesParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final UserListMessagesParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final UserListMessagesParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final UserListMessagesParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final UserListMessagesParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final UserListMessagesParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final UserListMessagesParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final UserListMessagesParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final UserListMessagesParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final UserListMessagesParams build()

  Returns an immutable instance of UserListMessagesParams.

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