SearchInAppsSDK Framework Reference

AI-generated Key Takeaways

• GetSearchSuggestionsOptions enables requesting search suggestions with various parameters.

• It uses textContext and locationContext to generate query and location-based suggestions respectively.

• A clientId can be specified if different from the one in Info.plist.

• Options can be initialized with either text or location contexts using designated initializers.

GetSearchSuggestionsOptions

@interface GetSearchSuggestionsOptions : NSObject

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

• textContext

  The text used to generate query-based search suggestions.

  Declaration

  Objective-C

  @property (nonatomic, copy) NSArray<NSString *> *_Nullable textContext;

• locationContext

  The information used to generate location-based search suggestions.

  Declaration

  Objective-C

  @property (nonatomic, copy) NSArray<LocationSuggestionsContext *> *_Nullable locationContext;

• clientId

  The client ID used to request search suggestions if it is different from the client ID specified in Info.plist.

  Declaration

  Objective-C

  @property (nonatomic, copy) NSString *_Nullable clientId;

• -initWithTextContext:

  Create options with a given text context (i.e. the strings used for generating search suggestions). \param textContext A list of strings used to generate search suggestions.

  Declaration

  Objective-C

  - (nonnull instancetype)initWithTextContext:
      (NSArray<NSString *> *_Nonnull)textContext;

• -initWithLocationContext:

  Create options with given location data (i.e. the location context used for generating location-based search suggestions). \param locationContext A list of LocationSuggestionsContext objects used to generate search suggestions.

  Declaration

  Objective-C

  - (nonnull instancetype)initWithLocationContext:
      (NSArray<LocationSuggestionsContext *> *_Nonnull)locationContext;

• -init

  Unavailable

  Undocumented

  Declaration

  Objective-C

  - (nonnull instancetype)init SWIFT_UNAVAILABLE;

• +new

  Unavailable

  -init is unavailable

  Undocumented

  Declaration

  Objective-C

  + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");