Class InlineIdentifyUserRequest
-
- All Implemented Interfaces:
public final class InlineIdentifyUserRequestA set of parameters to inline-identify a user with. Inline identifying the user will ensure that the user is available before the request is executed in Knock. It will perform an upsert for the user you're supplying, replacing any properties specified.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classInlineIdentifyUserRequest.BuilderA builder for InlineIdentifyUserRequest.
-
Method Summary
Modifier and Type Method Description final Stringid()The ID for the user that you set when identifying them in Knock. final Optional<InlineChannelDataRequest>channelData()A request to set channel data for a type of channel inline. final Optional<OffsetDateTime>createdAt()The creation date of the user from your system. final Optional<String>email()The primary email address for the user. final Optional<String>name()Display name of the user. final Optional<InlinePreferenceSetRequest>preferences()Inline set preferences for a recipient, where the key is the preference set id. final Optional<String>timezone()The timezone of the user. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<InlineChannelDataRequest>_channelData()Returns the raw JSON value of channelData. final JsonField<OffsetDateTime>_createdAt()Returns the raw JSON value of createdAt. final JsonField<String>_email()Returns the raw JSON value of email. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<InlinePreferenceSetRequest>_preferences()Returns the raw JSON value of preferences. final JsonField<String>_timezone()Returns the raw JSON value of timezone. final Map<String, JsonValue>_additionalProperties()final InlineIdentifyUserRequest.BuildertoBuilder()final InlineIdentifyUserRequestvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static InlineIdentifyUserRequest.Builderbuilder()Returns a mutable builder for constructing an instance of InlineIdentifyUserRequest. -
-
Method Detail
-
channelData
final Optional<InlineChannelDataRequest> channelData()
A request to set channel data for a type of channel inline.
-
createdAt
final Optional<OffsetDateTime> createdAt()
The creation date of the user from your system.
-
preferences
final Optional<InlinePreferenceSetRequest> preferences()
Inline set preferences for a recipient, where the key is the preference set id.
-
timezone
final Optional<String> timezone()
The timezone of the user. Must be a valid tz database time zone * string. Used for /concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_channelData
final JsonField<InlineChannelDataRequest> _channelData()
Returns the raw JSON value of channelData.
Unlike channelData, this method doesn't throw if the JSON field has an unexpected type.
-
_createdAt
final JsonField<OffsetDateTime> _createdAt()
Returns the raw JSON value of createdAt.
Unlike createdAt, this method doesn't throw if the JSON field has an unexpected type.
-
_email
final JsonField<String> _email()
Returns the raw JSON value of email.
Unlike email, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_preferences
final JsonField<InlinePreferenceSetRequest> _preferences()
Returns the raw JSON value of preferences.
Unlike preferences, this method doesn't throw if the JSON field has an unexpected type.
-
_timezone
final JsonField<String> _timezone()
Returns the raw JSON value of timezone.
Unlike timezone, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final InlineIdentifyUserRequest.Builder toBuilder()
-
validate
final InlineIdentifyUserRequest validate()
-
builder
final static InlineIdentifyUserRequest.Builder builder()
Returns a mutable builder for constructing an instance of InlineIdentifyUserRequest.
The following fields are required:
.id()
-
-
-
-