SearchInAppsSDK Framework Reference

Classes

The following classes are available globally.

  • Runtime for issuing contextual search requests.

    The runtime can be reused across the app after it is initialized.

    Declaration

    Swift

    @objc
final class ContextualSearchRuntime

  • This class contains all the options necessary to request search content.

    Declaration

    Swift

    @objc
final class GetSearchContentOptions

  • This class contains all the options necessary to request search suggestions.

    Declaration

    Swift

    @objc
final class GetSearchSuggestionsOptions

  • This class contains all the options necessary to request trending searches.

    Declaration

    Swift

    @objc
final class GetTrendingSearchesOptions

  • Context used for location-based search suggestions.

    Declaration

    Swift

    @objc
final class LocationSuggestionsContext

  • The data necessary to render a single SearchContentBlock.

    Declaration

    Swift

    @objc
final class SearchContentBlockData

  • Properties to pass to the partner’s delegate when a search content is clicked.

    Declaration

    Swift

    @objc
class SearchContentClickProperties

  • A class to make it easier to use the SearchContentView in UIKit applications.

    The way this is to be included in a UIViewController is to:

    1. Create an instance of a SearchContentViewController with a specified customization option _searchContentViewController = [[SearchContentViewController alloc] initWithCustomizationOption: [[SearchContentViewCustomizationOption alloc] init]];
    2. Add this to the view controller [_searchContentViewController addToViewController:self];
    3. Add its view to the parent view [self.view addSubview:_searchContentViewController.view];
    4. Assign search contents to it to render search content. dispatch_async(dispatch_get_main_queue(), ^{ _searchContentViewController.searchContents = _searchContents; }

    Declaration

    Swift

    @available(iOS, introduced: 14)
@objc
@objcMembers
class SearchContentViewController

  • A collection of search content block data

    Declaration

    Swift

    @available(iOS, introduced: 14)
@objc
final class SearchContents

  • A collection of search suggestions.

    This class is opaque externally, but is required for rendering search suggestions by the SDK.

    Declaration

    Swift

    @objc
final class SearchSuggestions

  • A class to make it easier to use the SearchSuggestionsView in UIKit applications.

    The way this is to be included in a UIViewController is to:

    1. Create an instance of a SearchSuggestionsViewController with a specified customization option _searchSuggestionsViewController = [[SearchSuggestionsViewController alloc] initWithCustomizationOption: [[SearchSuggestionsViewCustomizationOption alloc] init]];
    2. Add this to the view controller [_searchSuggestionsViewController addToViewController:self];
    3. Add its view to the parent view [self.view addSubview:_searchSuggestionsViewController.view];
    4. Assign search suggestions to it to render those search suggestions. dispatch_async(dispatch_get_main_queue(), ^{ _searchSuggestionsViewController.searchSuggestions = _searchSuggestions; }

    Declaration

    Swift

    @available(iOS, introduced: 14)
@objc
@objcMembers
class SearchSuggestionsViewController

  • This class provides all the options to customize the search suggestions UI view.

    Declaration

    Swift

    @objc
class SearchSuggestionsViewOptions