MessageContentImageFile class abstract

The image file that is part of a message.

Available extensions

• MessageContentImageFilePatterns

Annotations

• @freezed

Constructors

MessageContentImageFile({@JsonKey.new(name: 'file_id') required String fileId, @Default.new(MessageContentImageDetail.auto) MessageContentImageDetail detail})

Factory constructor for MessageContentImageFile

const

factory

MessageContentImageFile.fromJson(Map<String, dynamic> json)

Object construction from a JSON representation

factory

Properties

copyWith → $MessageContentImageFileCopyWith<MessageContentImageFile>

Create a copy of MessageContentImageFile with the given fields replaced by the non-null parameter values.

no setter, inherited

detail → MessageContentImageDetail

Specifies the detail level of the image if specified by the user. low uses fewer tokens, you can opt in to high resolution using high.

no setter, inherited

fileId → String

The File ID of the image in the message content. Set purpose="vision" when uploading the File if you need to later display the file content.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

map<TResult extends Object?>(TResult $default(_MessageContentImageFile value)) → TResult

Available on MessageContentImageFile, provided by the MessageContentImageFilePatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>(TResult? $default(_MessageContentImageFile value)?) → TResult?

Available on MessageContentImageFile, provided by the MessageContentImageFilePatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>(TResult $default(_MessageContentImageFile value)?, {required TResult orElse()}) → TResult

Available on MessageContentImageFile, provided by the MessageContentImageFilePatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String fileId, MessageContentImageDetail detail)?, {required TResult orElse()}) → TResult

Available on MessageContentImageFile, provided by the MessageContentImageFilePatterns extension

A variant of when that fallback to an orElse callback.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this MessageContentImageFile to a JSON map.

inherited

toMap() → Map<String, dynamic>

Map representation of object (not serialized)

toString() → String

A string representation of this object.

inherited

validateSchema() → String?

Perform validations on the schema property values

when<TResult extends Object?>(TResult $default(String fileId, MessageContentImageDetail detail)) → TResult

Available on MessageContentImageFile, provided by the MessageContentImageFilePatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String fileId, MessageContentImageDetail detail)?) → TResult?

Available on MessageContentImageFile, provided by the MessageContentImageFilePatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

propertyNames → const List<String>

List of all property names of schema