HERE iOS SDK Developer's Guide

<NMAVoiceCatalogDelegate>

Protocol Summary

protocol <NMAVoiceCatalogDelegate>

Derived from: <NSObject>

.

Include: NMAKit.framework/headers/NMAVoiceCatalog.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for <NMAVoiceCatalogDelegate> – <NMAVoiceCatalogDelegate>

[For complete information, see the section Protocol Details]

Instance Method Summary

Table 1. Instance Methods
Instance Method Summary

- @optional (void) voiceCatalog:(nonnull NMAVoiceCatalog *) voiceCatalog didInstallPackage:(nonnull NMAVoicePackage *) package withError:(nullable NSError *) error

Sent when a voice package installation request completes.

- @optional (void) voiceCatalog:(nonnull NMAVoiceCatalog *) voiceCatalog didUncompressProgress:(float) progress forPackage:(nonnull NMAVoicePackage *) package

- @optional (void) voiceCatalog:(nonnull NMAVoiceCatalog *) voiceCatalog didUpdateProgress:(float) progress forPackage:(nonnull NMAVoicePackage *) package

- @optional (void) voiceCatalog:(nonnull NMAVoiceCatalog *) voiceCatalog didUpdateWithError:(nullable NSError *) error

Sent when a voice catalog update request completes.

Protocol Details

Delegate to handle NMAVoiceCatalog Download notifications

Note:

Methods of this protocol are called on the main thread.

Instance Method Details

- @optional (void) voiceCatalog:(nonnull NMAVoiceCatalog *) voiceCatalog didInstallPackage:(nonnull NMAVoicePackage *) package withError:(nullable NSError *) error

Sent when a voice package installation request completes.

This method will be called whether the installation succeeds, fails or is cancelled

See [ NMAVoiceCatalog installVoicePackage:] and [ NMAVoiceCatalog cancel]

Parameters:

  • voiceCatalog

    The NMAVoiceCatalog singleton

  • package

    The NMAVoicePackage being installed

  • error

    nil if the request completed successfully otherwise an NSError populated with an NMAVoiceCatalogError error code and a domain of NMAVoiceCatalogErrorDomain

- @optional (void) voiceCatalog:(nonnull NMAVoiceCatalog *) voiceCatalog didUncompressProgress:(float) progress forPackage:(nonnull NMAVoicePackage *) package

NMAVoicePackage uncompress progress, called multiple times

See [ NMAVoiceCatalog installVoicePackage:]

Parameters:

  • voiceCatalog

    The NMAVoiceCatalog singleton.

  • progress

    The progress of the current operation from [0:100].

  • package

    The NMAVoicePackage being uncompressed.

- @optional (void) voiceCatalog:(nonnull NMAVoiceCatalog *) voiceCatalog didUpdateProgress:(float) progress forPackage:(nonnull NMAVoicePackage *) package

NMAVoicePackage download progress, called multiple times

See [ NMAVoiceCatalog installVoicePackage:]

Parameters:

  • voiceCatalog

    The NMAVoiceCatalog singleton.

  • progress

    The progress of the current operation from [0:100].

  • package

    The NMAVoicePackage being downloaded.

- @optional (void) voiceCatalog:(nonnull NMAVoiceCatalog *) voiceCatalog didUpdateWithError:(nullable NSError *) error

Sent when a voice catalog update request completes.

This method will be called whether the update succeeds, fails or is cancelled

See [ NMAVoiceCatalog updateVoiceCatalog] and [ NMAVoiceCatalog cancel]

Parameters:

  • voiceCatalog

    The NMAVoiceCatalog singleton

  • error

    nil if the request completed successfully otherwise an NSError populated with an NMAVoiceCatalogError error code and a domain of NMAVoiceCatalogErrorDomain