AWSLexPostTextRequest

Objective-C

@interface AWSLexPostTextRequest

Swift

class AWSLexPostTextRequest

  • A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

    If you don’t specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSLexActiveContext *> *_Nullable activeContexts;

    Swift

    var activeContexts: [AWSLexActiveContext]? { get set }

  • The alias of the Amazon Lex bot.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable botAlias;

    Swift

    var botAlias: String? { get set }

  • The name of the Amazon Lex bot.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable botName;

    Swift

    var botName: String? { get set }

  • The text that the user entered (Amazon Lex interprets this text).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable inputText;

    Swift

    var inputText: String? { get set }

  • Request-specific information passed between Amazon Lex and a client application.

    The namespace x-amz-lex: is reserved for special attributes. Don’t create any request attributes with the prefix x-amz-lex:.

    For more information, see Setting Request Attributes.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable requestAttributes;

    Swift

    var requestAttributes: [String : String]? { get set }

  • Application-specific information passed between Amazon Lex and a client application.

    For more information, see Setting Session Attributes.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable sessionAttributes;

    Swift

    var sessionAttributes: [String : String]? { get set }

  • The ID of the client application user. Amazon Lex uses this to identify a user’s conversation with your bot. At runtime, each request must contain the userID field.

    To decide the user ID to use for your application, consider the following factors.

    • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

    • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

    • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

    • A user can’t have two independent conversations with two different versions of the same bot. For example, a user can’t have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userId;

    Swift

    var userId: String? { get set }