Class SPXDialogBotFrameworkConfiguration

Declaration

@class SPXDialogBotFrameworkConfiguration : SPXDialogServiceConfiguration;

Description

The specialized configuration type used to initialize a DialogServiceConnector that will connect to a Bot Framework bot using the Direct Line Speech channel.

See also: What is Direct Line Speech?.

Methods

initWithSubscription:region:botId:error:

Initializes a dialog configuration object used to create a DialogServiceConnector that will communicate with a Bot Framework bot via the Direct Line Speech channel.

- (instancetype _Nullable)initWithSubscription:(NSString * _Nonnull)subscriptionKey
    region:(NSString * _Nonnull)region botId:(NSString * _Nullable)botId
    error:(NSError * _Nullable * _Nullable)outError

Parameters

• subscriptionKey - the subscription key to be used.
• region - the region name for the subscription (see the region page).
• botId - the identifier of a specific bot resource to request, even if it's not the default for this subscription.
• outError - error information.

Returns

a configuration object used to initialize a DialogServiceConnector.

initWithSubscription:region:botId:

Initializes a dialog configuration object used to create a DialogServiceConnector that will communicate with a Bot Framework bot.

- (instancetype _Nonnull)initWithSubscription:(NSString * _Nonnull)subscriptionKey
    region:(NSString * _Nonnull)region botId:(NSString * _Nullable)botId

Parameters

• subscriptionKey - the subscription key to be used.
• region - the region name for the subscription (see the region page).
• botId - the identifier of a specific bot resource to request, even if it's not the default for this subscription.

Returns

a configuration object used to initialize a DialogServiceConnector.

initWithSubscription:region:error:

Initializes a dialog configuration object used to create a DialogServiceConnector that will communicate with a Bot Framework bot. This will connect to the default bot associated with the Direct Line Speech channel for the speech service resource.

- (instancetype _Nullable)initWithSubscription:(NSString * _Nonnull)subscriptionKey
    region:(NSString * _Nonnull)region error:(NSError * _Nullable * _Nullable)outError

Parameters

• subscriptionKey - the subscription key to be used.
• region - the region name for the subscription (see the region page).
• outError - error information.

Returns

a configuration object used to initialize a DialogServiceConnector.

initWithSubscription:region:

Initializes a dialog configuration object used to create a DialogServiceConnector that will communicate with a Bot Framework bot. This will connect to the default bot associated with the Direct Line Speech channel for the speech service resource.

- (instancetype _Nonnull)initWithSubscription:(NSString * _Nonnull)subscriptionKey
    region:(NSString * _Nonnull)region

Parameters

• subscriptionKey - the subscription key to be used.
• region - the region name for the subscription (see the region page).

Returns

a configuration object used to initialize a DialogServiceConnector.

initWithAuthorizationToken:region:botId:error:

Initializes a dialog configuration object used to create a DialogServiceConnector that will communicate with a Bot Framework bot.

Note: An authorization token must be obtained before this call and checked for validity. Before an authorization token expires, it must be refreshed by assigning a new token on the corresponding property present on the DialogServiceConnector created with the configuration object created with this call.

- (instancetype _Nullable)initWithAuthorizationToken:(NSString * _Nonnull)authorizationToken
    region:(NSString * _Nonnull)region botId:(NSString * _Nullable)botId
    error:(NSError * _Nullable * _Nullable)outError

Parameters

• authorizationToken - the authorization token.
• region - the region name for the subscription (see the region page).
• botId - the identifier of a specific bot resource to request, even if it's not the default for this subscription.
• outError - error information.

Returns

a configuration object used to initialize a DialogServiceConnector.

initWithAuthorizationToken:region:botId:

Initializes a dialog configuration object used to create a DialogServiceConnector that will communicate with a Bot Framework bot.

Note: An authorization token must be obtained before this call and checked for validity. Before an authorization token expires, it must be refreshed by assigning a new token on the corresponding property present on the DialogServiceConnector created with the configuration object created with this call.

- (instancetype _Nonnull)initWithAuthorizationToken:(NSString * _Nonnull)authorizationToken
    region:(NSString * _Nonnull)region botId:(NSString * _Nullable)botId

Parameters

• authorizationToken - the authorization token.
• region - the region name for the subscription (see the region page).
• botId - the identifier of a specific bot resource to request, even if it's not the default for this subscription.

Returns

a configuration object used to initialize a DialogServiceConnector.

initWithAuthorizationToken:region:error:

Initializes a dialog configuration object used to create a DialogServiceConnector that will communicate with a Bot Framework bot. This will connect to the default bot associated with the Direct Line Speech channel for the speech service resource.

Note: An authorization token must be obtained before this call and checked for validity. Before an authorization token expires, it must be refreshed by assigning a new token on the corresponding property present on the DialogServiceConnector created with the configuration object created with this call.

- (instancetype _Nullable)initWithAuthorizationToken:(NSString * _Nonnull)authorizationToken
    region:(NSString * _Nonnull)region error:(NSError * _Nullable * _Nullable)outError

Parameters

• authorizationToken - the authorization token.
• region - the region name for the subscription (see the region page).
• outError - error information.

Returns

a configuration object used to initialize a DialogServiceConnector.

initWithAuthorizationToken:region:

Initializes a dialog configuration object used to create a DialogServiceConnector that will communicate with a Bot Framework bot. This will connect to the default bot associated with the Direct Line Speech channel for the speech service resource.

Note: An authorization token must be obtained before this call and checked for validity. Before an authorization token expires, it must be refreshed by assigning a new token on the corresponding property present on the DialogServiceConnector created with the configuration object created with this call.

- (instancetype _Nonnull)initWithAuthorizationToken:(NSString * _Nonnull)authorizationToken
    region:(NSString * _Nonnull)region

Parameters

• authorizationToken - the authorization token.
• region - the region name for the subscription (see the region page).

Returns

a configuration object used to initialize a DialogServiceConnector.