Class BulkSetPreferencesParams
-
- All Implemented Interfaces:
-
app.knock.api.core.Params
public final class BulkSetPreferencesParams implements Params
Sets preferences for multiple users in a single operation. Supports either setting the same preferences for multiple users or specific preferences for each user.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBulkSetPreferencesParams.BuilderA builder for BulkSetPreferencesParams.
public final classBulkSetPreferencesParams.BodyA request to set preferences for a set of users in bulk.
-
Method Summary
Modifier and Type Method Description final PreferenceSetRequestpreferences()A request to set a preference set for a recipient. final List<String>userIds()A list of user IDs. final JsonField<PreferenceSetRequest>_preferences()Returns the raw JSON value of preferences. final JsonField<List<String>>_userIds()Returns the raw JSON value of userIds. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final BulkSetPreferencesParams.BuildertoBuilder()final BulkSetPreferencesParams.Body_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static BulkSetPreferencesParams.Builderbuilder()Returns a mutable builder for constructing an instance of BulkSetPreferencesParams. -
-
Method Detail
-
preferences
final PreferenceSetRequest preferences()
A request to set a preference set for a recipient.
-
_preferences
final JsonField<PreferenceSetRequest> _preferences()
Returns the raw JSON value of preferences.
Unlike preferences, this method doesn't throw if the JSON field has an unexpected type.
-
_userIds
final JsonField<List<String>> _userIds()
Returns the raw JSON value of userIds.
Unlike userIds, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final BulkSetPreferencesParams.Builder toBuilder()
-
_body
final BulkSetPreferencesParams.Body _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static BulkSetPreferencesParams.Builder builder()
Returns a mutable builder for constructing an instance of BulkSetPreferencesParams.
The following fields are required:
.preferences() .userIds()
-
-
-
-