class Hamilton::Types::LinkPreviewOptions

• Hamilton::Types::LinkPreviewOptions
• Reference
• Object

Overview

Describes the options used for link preview generation.

Included Modules

• Hamilton::Types::Common
• JSON::Serializable

Defined in:

types/link_preview_options.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(params)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)
• .new(**params)

Instance Method Summary

• #is_disabled : Bool | Nil

  True, if the link preview is disabled.

• #is_disabled=(is_disabled : Bool | Nil)

  True, if the link preview is disabled.

• #non_nil_fields : Array(String)

  List of available non-nil fields.

• #non_nil_fields=(non_nil_fields : Array(String))

  List of available non-nil fields.

• #prefer_large_media : Bool | Nil

  True, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview.

• #prefer_large_media=(prefer_large_media : Bool | Nil)

  True, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview.

• #prefer_small_media : Bool | Nil

  True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview.

• #prefer_small_media=(prefer_small_media : Bool | Nil)

  True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview.

• #show_above_text : Bool | Nil

  True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text.

• #show_above_text=(show_above_text : Bool | Nil)

  True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text.

• #url : String | Nil

  URL to use for the link preview.

• #url=(url : String | Nil)

  URL to use for the link preview.

Constructor Detail

Instance Method Detail