They delegate of a keyboard popup allowing customization at runtime of the keyboard.
The keyboard session completed with some input.
This will be sent upon ENTRY_SUBMITTED or ENTRY_VOICE. If the event is ENTRY_VOICE, the user requested to start a voice session in order to submit input to this keyboard. This MUST be handled by you. Start an Audio Pass Thru session if supported.
- (void)userDidSubmitInput:(nonnull NSString *)inputText
withEvent:(nonnull SDLKeyboardEvent)source;
func userDidSubmitInput(_ inputText: String, withEvent source: SDLKeyboardEvent)
The submitted input text on the keyboard
ENTRY_SUBMITTED if the user pressed the submit button on the keyboard, ENTRY_VOICE if the user requested that a voice session begin
The keyboard session aborted.
This will be sent if the keyboard event ENTRY_CANCELLED or ENTRY_ABORTED is sent
- (void)keyboardDidAbortWithReason:(nonnull SDLKeyboardEvent)event;
func keyboardDidAbort(withReason event: SDLKeyboardEvent)
ENTRY_CANCELLED if the user cancelled the keyboard input, or ENTRY_ABORTED if the system aborted the input due to a higher priority event
Implement this in order to provide a custom keyboard configuration to just this keyboard. To apply default settings to all keyboards, see SDLScreenManager.keyboardConfiguration
- (nonnull SDLKeyboardProperties *)customKeyboardConfiguration;
optional func customKeyboardConfiguration() -> SDLKeyboardProperties
The custom keyboard configuration to use.
Implement this if you wish to updated the KeyboardProperties.autoCompleteList as the user updates their input. This is called upon a KEYPRESS event.
This allows you to present a list of options that the user can use to fill in the search / text box with suggestions you provide.
- (void)updateAutocompleteWithInput:(nonnull NSString *)currentInputText
autoCompleteResultsHandler:
(nonnull SDLKeyboardAutoCompleteResultsHandler)resultsHandler;
optional func updateAutocomplete(withInput currentInputText: String, autoCompleteResultsHandler resultsHandler: @escaping SDLKeyboardAutoCompleteResultsHandler)
The user’s full current input text
A completion handler to update the autoCompleteList
Implement this if you wish to update the limitedCharacterSet as the user updates their input. This is called upon a KEYPRESS event.
- (void)updateCharacterSetWithInput:(nonnull NSString *)currentInputText
completionHandler:
(nonnull SDLKeyboardCharacterSetCompletionHandler)
completionHandler;
optional func updateCharacterSet(withInput currentInputText: String, completionHandler: @escaping SDLKeyboardCharacterSetCompletionHandler)
The user’s full current input text
A completion handler to update the limitedCharacterSet
Implement this to be notified of all events occurring on the keyboard
- (void)keyboardDidSendEvent:(nonnull SDLKeyboardEvent)event
text:(nonnull NSString *)currentInputText;
optional func keyboardDidSendEvent(_ event: SDLKeyboardEvent, text currentInputText: String)
The event that occurred
The user’s full current input text