Class User
-
- All Implemented Interfaces:
public final class UserA /concepts/users represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifications and are always referenced by your internal identifier.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classUser.BuilderA builder for User.
-
Method Summary
Modifier and Type Method Description final Stringid()The ID for the user that you set when identifying them in Knock. final String_typename()The typename of the schema. final OffsetDateTimeupdatedAt()The timestamp when the resource was last updated. final Optional<String>avatar()URL to the user's avatar image. 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<String>phoneNumber()The E.164 phone number of the user (required for SMS channels). final Optional<String>timezone()The timezone of the user. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<String>__typename()Returns the raw JSON value of _typename. final JsonField<OffsetDateTime>_updatedAt()Returns the raw JSON value of updatedAt. final JsonField<String>_avatar()Returns the raw JSON value of avatar. 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<String>_phoneNumber()Returns the raw JSON value of phoneNumber. final JsonField<String>_timezone()Returns the raw JSON value of timezone. final Map<String, JsonValue>_additionalProperties()final User.BuildertoBuilder()final Uservalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static User.Builderbuilder()Returns a mutable builder for constructing an instance of User. -
-
Method Detail
-
updatedAt
final OffsetDateTime updatedAt()
The timestamp when the resource was last updated.
-
createdAt
final Optional<OffsetDateTime> createdAt()
The creation date of the user from your system.
-
phoneNumber
final Optional<String> phoneNumber()
The E.164 phone number of the user (required for SMS channels).
-
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.
-
__typename
final JsonField<String> __typename()
Returns the raw JSON value of _typename.
Unlike _typename, this method doesn't throw if the JSON field has an unexpected type.
-
_updatedAt
final JsonField<OffsetDateTime> _updatedAt()
Returns the raw JSON value of updatedAt.
Unlike updatedAt, this method doesn't throw if the JSON field has an unexpected type.
-
_avatar
final JsonField<String> _avatar()
Returns the raw JSON value of avatar.
Unlike avatar, 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.
-
_phoneNumber
final JsonField<String> _phoneNumber()
Returns the raw JSON value of phoneNumber.
Unlike phoneNumber, 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 User.Builder toBuilder()
-
builder
final static User.Builder builder()
Returns a mutable builder for constructing an instance of User.
The following fields are required:
.id() ._typename() .updatedAt()
-
-
-
-