Class SPXDialogCustomCommandsConfiguration

Declaration

@class SPXDialogCustomCommandsConfiguration : SPXDialogServiceConfiguration;

Description

The instance interface type used to initialize a DialogServiceConnector that will connect to a Custom Commands application as published from Speech Studio for a speech service resource.

See also: What is Custom Commands?.

Methods

initWithSubscription:appId:region:error:

Initializes a dialog configuration object used to create a DialogServiceConnector that will communicate with a Custom Commands application. Requires an identifier for a published Custom Commands application associated with the referenced speech service resource.

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

Parameters

• subscriptionKey - the subscription key to be used.
• appId - the identifier for the Custom Commands application to use, as selected from the subscription.
• region - the region name for the subscription (see the region page).
• outError - error information.

Returns

a configuration object used to initialize a DialogServiceConnector.

initWithSubscription:appId:region:

Initializes a dialog configuration object used to create a DialogServiceConnector that will communicate with a Custom Commands application. Requires an identifier for a published Custom Commands application associated with the referenced speech service resource.

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

Parameters

• subscriptionKey - the subscription key to be used.
• appId - the identifier for the Custom Commands application to use, as selected from the subscription.
• region - the region name for the subscription (see the region page).

Returns

a configuration object used to initialize a DialogServiceConnector.

initWithAuthorizationToken:appId:region:error:

Initializes a dialog configuration object used to create a DialogServiceConnector that will communicate with a Custom Commands application. Requires an identifier for a published Custom Commands application associated with the referenced 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
    appId:(NSString * _Nonnull)appId region:(NSString * _Nonnull)region
    error:(NSError * _Nullable * _Nullable)outError

Parameters

• authorizationToken - the authorization token.
• appId - the identifier for the Custom Commands application to use, as selected from the subscription.
• region - the region name for the subscription (see the region page).
• outError - error information.

Returns

a configuration object used to initialize a DialogServiceConnector.

initWithAuthorizationToken:appId:region:

Initializes a dialog configuration object used to create a DialogServiceConnector that will communicate with a Custom Commands application. Requires an identifier for a published Custom Commands application associated with the referenced 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
    appId:(NSString * _Nonnull)appId region:(NSString * _Nonnull)region

Parameters

• authorizationToken - the authorization token.
• appId - the identifier for the Custom Commands application to use, as selected from the subscription.
• region - the region name for the subscription (see the region page).

Returns

a configuration object used to initialize a DialogServiceConnector.