SlyceSearchRequest Class Reference
Inherits from | NSObject |
---|---|
Conforms to | NSCoding |
Declared in | SlyceSearchRequest.h |
– initWithImage:anchor:searchParameters:
Initializes a new SlyceSearchRequest
.
- (instancetype)initWithImage:(UIImage *)image anchor:(CGPoint)anchor searchParameters:(nullable SlyceSearchParameters *)searchParameters
Parameters
image |
|
---|---|
anchor |
|
searchParameters |
|
Return Value
A SlyceSearchRequest
instance.
Discussion
Use this method to create a new SlyceSearchRequest
.
Declared In
SlyceSearchRequest.h
– initWithImage:searchParameters:
Initializes a new SlyceSearchRequest
.
- (instancetype)initWithImage:(UIImage *)image searchParameters:(nullable SlyceSearchParameters *)searchParameters
Parameters
image |
|
---|---|
searchParameters |
|
Return Value
A SlyceSearchRequest
instance.
Discussion
Use this method to create a new SlyceSearchRequest
.
Declared In
SlyceSearchRequest.h
– initWithImageURL:anchor:searchParameters:
- (instancetype)initWithImageURL:(NSString *)imageURL anchor:(CGPoint)anchor searchParameters:(nullable SlyceSearchParameters *)searchParameters
Parameters
imageURL |
|
---|---|
anchor |
|
searchParameters |
|
Return Value
A SlyceSearchRequest
instance.
Discussion
Use this method to create a new SlyceSearchRequest
.
Declared In
SlyceSearchRequest.h
– initWithImageURL:searchParameters:
Initializes a new SlyceSearchRequest
for an image URL.
- (instancetype)initWithImageURL:(NSString *)imageURL searchParameters:(nullable SlyceSearchParameters *)searchParameters
Parameters
imageURL |
|
---|---|
searchParameters |
|
Return Value
A SlyceSearchRequest
instance.
Discussion
Use this method to create a new SlyceSearchRequest
.
Declared In
SlyceSearchRequest.h
– initWithSearchParameters:
Initializes a new SlyceSearchRequest
.
- (instancetype)initWithSearchParameters:(SlyceSearchParameters *)searchParameters
Parameters
searchParameters |
|
---|
Return Value
A SlyceSearchRequest
instance.
Discussion
Use this method to create an empty SlyceSearchRequest
. This assumes that search criteria with be supplied in workflow options; for example, “product_id” for find similar searches.
Declared In
SlyceSearchRequest.h
timestamp
The time that the request was created.
@property (nonatomic, strong, readonly) NSDate *timestamp
Declared In
SlyceSearchRequest.h
languageCode
The ISO 639-1 alpha-2 language code for this request.
@property (nonatomic, readonly, nullable) NSString *languageCode
Declared In
SlyceSearchRequest.h
countryCode
The ISO 3166-1 alpha-2 country code for this request.
@property (nonatomic, readonly, nullable) NSString *countryCode
Declared In
SlyceSearchRequest.h
demoMode
Gets demo mode setting.
@property (nonatomic, readonly) BOOL demoMode
Discussion
If demo mode is enabled, some of the more time consuming operations will be disabled. This also clients to receive faster, but less accurate results while integrating the SlyceSDK. Demo mode should not be enabled in your production application.
Declared In
SlyceSearchRequest.h
image
The image related to this search request.
@property (nonatomic, readonly, nullable) UIImage *image
Discussion
Before this request is queued on a search task, this property will return the original image the request was created with. Once a task has been queued, this propery will return a down-scaled version of the original image.
Declared In
SlyceSearchRequest.h
imageURL
An optional URL of an image that you wish to perform a visual search on.
@property (nonatomic, readonly, nullable) NSString *imageURL
Declared In
SlyceSearchRequest.h
anchor
An optional anchor point that indicates an area of interest within the supplied image.
@property (nonatomic, readonly) CGPoint anchor
Discussion
This property will always return an anchor point correctly scaled to the image
property.
Before the search request is queue, this will return the original anchor.
After the search request is queueud, this will return an anchor properly scaled to the image
property.
Declared In
SlyceSearchRequest.h
legacySearchType
Gets the legacy search type.
@property (nonatomic, readonly, nullable) NSString *legacySearchType
Discussion
Gets the legacy search type (“1D”, “2D”, or “3D”) or nil
if the legacy type cannot be determined.
Declared In
SlyceSearchRequest.h