SearchInAppsSDK Framework Reference

Classes

The following classes are available globally.

• ContextualSearchRuntime

  Runtime for issuing contextual search requests. The runtime can be reused across the app after it is initialized.

  Declaration

  Objective-C

  
  @interface ContextualSearchRuntime : NSObject

• GetSearchContentOptions

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

  Declaration

  Objective-C

  
  @interface GetSearchContentOptions : NSObject <NSCopying>

• GetSearchSuggestionsOptions

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

  Declaration

  Objective-C

  
  @interface GetSearchSuggestionsOptions : NSObject

• GetTrendingSearchesOptions

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

  Declaration

  Objective-C

  
  @interface GetTrendingSearchesOptions : NSObject

• LocationSuggestionsContext

  Context used for location-based search suggestions.

  Declaration

  Objective-C

  
  @interface LocationSuggestionsContext : NSObject

• SearchContentBlockData

  The data necessary to render a single SearchContentBlock.

  Declaration

  Objective-C

  
  @interface SearchContentBlockData : NSObject

• SearchContentClickProperties

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

  Declaration

  Objective-C

  
  @interface SearchContentClickProperties : NSObject

• SearchContentViewController

  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

  Objective-C

  
  @interface SearchContentViewController : NSObject

• SearchContents

  A collection of search content block data

  Declaration

  Objective-C

  
  @interface SearchContents : NSObject

• SearchSuggestions

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

  Declaration

  Objective-C

  
  @interface SearchSuggestions : NSObject

• SearchSuggestionsViewController

  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

  Objective-C

  
  @interface SearchSuggestionsViewController : NSObject

• SearchSuggestionsViewOptions

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

  Declaration

  Objective-C

  
  @interface SearchSuggestionsViewOptions : NSObject