Class: AWSCDK::Lex::CfnBot::DTMFSpecificationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lex/cfn_bot.rb

Overview

Specifies the DTMF input specifications.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(deletion_character:, end_character:, end_timeout_ms:, max_length:) ⇒ DTMFSpecificationProperty

Returns a new instance of DTMFSpecificationProperty.

Parameters:

  • deletion_character (String)

    The DTMF character that clears the accumulated DTMF digits and immediately ends the input.

  • end_character (String)

    The DTMF character that immediately ends input.

  • end_timeout_ms (Numeric)

    How long the bot should wait after the last DTMF character input before assuming that the input has concluded.

  • max_length (Numeric)

    The maximum number of DTMF digits allowed in an utterance.



2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
# File 'lex/cfn_bot.rb', line 2046

def initialize(deletion_character:, end_character:, end_timeout_ms:, max_length:)
  @deletion_character = deletion_character
  Jsii::Type.check_type(@deletion_character, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deletionCharacter")
  @end_character = end_character
  Jsii::Type.check_type(@end_character, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endCharacter")
  @end_timeout_ms = end_timeout_ms
  Jsii::Type.check_type(@end_timeout_ms, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "endTimeoutMs")
  @max_length = max_length
  Jsii::Type.check_type(@max_length, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxLength")
end

Instance Attribute Details

#deletion_characterString (readonly)

The DTMF character that clears the accumulated DTMF digits and immediately ends the input.



2061
2062
2063
# File 'lex/cfn_bot.rb', line 2061

def deletion_character
  @deletion_character
end

#end_characterString (readonly)

The DTMF character that immediately ends input.

If the user does not press this character, the input ends after the end timeout.



2068
2069
2070
# File 'lex/cfn_bot.rb', line 2068

def end_character
  @end_character
end

#end_timeout_msNumeric (readonly)

How long the bot should wait after the last DTMF character input before assuming that the input has concluded.



2073
2074
2075
# File 'lex/cfn_bot.rb', line 2073

def end_timeout_ms
  @end_timeout_ms
end

#max_lengthNumeric (readonly)

The maximum number of DTMF digits allowed in an utterance.



2078
2079
2080
# File 'lex/cfn_bot.rb', line 2078

def max_length
  @max_length
end

Class Method Details

.jsii_propertiesObject



2080
2081
2082
2083
2084
2085
2086
2087
# File 'lex/cfn_bot.rb', line 2080

def self.jsii_properties
  {
    :deletion_character => "deletionCharacter",
    :end_character => "endCharacter",
    :end_timeout_ms => "endTimeoutMs",
    :max_length => "maxLength",
  }
end

Instance Method Details

#to_jsiiObject



2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
# File 'lex/cfn_bot.rb', line 2089

def to_jsii
  result = {}
  result.merge!({
    "deletionCharacter" => @deletion_character,
    "endCharacter" => @end_character,
    "endTimeoutMs" => @end_timeout_ms,
    "maxLength" => @max_length,
  })
  result.compact
end