Class ImagePart
-
- All Implemented Interfaces:
public final class ImagePart
Metadata for an image uploaded through ChatKit.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ImagePart.Builder
A builder for ImagePart.
-
Method Summary
Modifier and Type Method Description final String
id()
Unique identifier for the uploaded image. final String
mimeType()
MIME type of the uploaded image. final Optional<String>
name()
Original filename for the uploaded image. final String
previewUrl()
Preview URL that can be rendered inline for the image. final JsonValue
_type()
Type discriminator that is always image
.final Optional<String>
uploadUrl()
Signed URL for downloading the uploaded image. final JsonField<String>
_id()
Returns the raw JSON value of id. final JsonField<String>
_mimeType()
Returns the raw JSON value of mimeType. final JsonField<String>
_name()
Returns the raw JSON value of name. final JsonField<String>
_previewUrl()
Returns the raw JSON value of previewUrl. final JsonField<String>
_uploadUrl()
Returns the raw JSON value of uploadUrl. final Map<String, JsonValue>
_additionalProperties()
final ImagePart.Builder
toBuilder()
final ImagePart
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ImagePart.Builder
builder()
Returns a mutable builder for constructing an instance of ImagePart. -
-
Method Detail
-
name
final Optional<String> name()
Original filename for the uploaded image. Defaults to null when unnamed.
-
previewUrl
final String previewUrl()
Preview URL that can be rendered inline for the image.
-
_type
final JsonValue _type()
Type discriminator that is always
image
.Expected to always return the following:
JsonValue.from("image")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
uploadUrl
final Optional<String> uploadUrl()
Signed URL for downloading the uploaded image. Defaults to null when no download link is available.
-
_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.
-
_mimeType
final JsonField<String> _mimeType()
Returns the raw JSON value of mimeType.
Unlike mimeType, 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.
-
_previewUrl
final JsonField<String> _previewUrl()
Returns the raw JSON value of previewUrl.
Unlike previewUrl, this method doesn't throw if the JSON field has an unexpected type.
-
_uploadUrl
final JsonField<String> _uploadUrl()
Returns the raw JSON value of uploadUrl.
Unlike uploadUrl, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ImagePart.Builder toBuilder()
-
builder
final static ImagePart.Builder builder()
Returns a mutable builder for constructing an instance of ImagePart.
The following fields are required:
.id() .mimeType() .name() .previewUrl() .uploadUrl()
-
-
-
-