TMBDiscoverBasicParams Class Reference


                    
                    
                    +discoverRecommendations:

The simplest way to get TMBDiscoverBasicParams for user recommendations – only set the number of recommended items (TMBDiscovery objects) you want to return.

Warning

The TMBClient userId must be set with setUser.

Declaration

Objective-C

+ (nullable instancetype)discoverRecommendations:(nullable NSNumber *)number;

Swift

class func discoverRecommendations(_ number: NSNumber?) -> Self?

Parameters


                                number

Number of recommendations to return.

Show on GitHub


                    
                    
                    +discoverRecommendations:page:filter:getProperties:testEvents:

Expanded discover params for user recommendations.

Declaration

Objective-C

+ (nullable instancetype)discoverRecommendations:(nullable NSNumber *)number
                                            page:(nullable NSNumber *)page
                                          filter:(nullable NSDictionary *)filter
                                   getProperties:(BOOL)getProperties
                                      testEvents:(nullable NSArray *)testEvents;

Swift

class func discoverRecommendations(_ number: NSNumber?, page: NSNumber?, filter: [AnyHashable : Any]?, getProperties: Bool, testEvents: [Any]?) -> Self?

Parameters

`number`	Number of recommendations to return. Maximum of 500.
`page`	The page of recommended items to return.
`filter`	The filter to apply on the discoveries. See https://tamber.com/docs/api/#filtering and our filtering guide at https://tamber.com/docs/guides/filtering.html for reference.
`getProperties`	Include items’ properties and tags in the discovery objects.
`testEvents`	Recommendations will be made as if the supplied events had occurred, but the engine will not be affected in any way. Also works if the user that has not yet been created, allowing you to see what a visiting user’s recommendations would be. Warning: recommendations with test_events are generated at a lower priority of computational resources and are not representative of recommendation API performance.

Show on GitHub


                    
                    
                    +discoverParamsWithUser:number:

Discover params for user recommendations.

Declaration

Objective-C

+ (nullable instancetype)discoverParamsWithUser:(nullable NSString *)user
                                         number:(nullable NSNumber *)number;

Swift

class func discover(withUser user: String?, number: NSNumber?) -> Self?

Parameters

`user`	User’s unique identifier.
`number`	Number of recommendations to return.

Show on GitHub


                    
                    
                    -initWithUser:item:number:page:filter:getProperties:testEvents:

Initialize discover params for user recommendations.

Declaration

Objective-C

- (nullable instancetype)initWithUser:(nullable NSString *)user
                                 item:(nullable NSString *)item
                               number:(nullable NSNumber *)number
                                 page:(nullable NSNumber *)page
                               filter:(nullable NSDictionary *)filter
                        getProperties:(BOOL)getProperties
                           testEvents:(nullable NSArray *)testEvents;

Swift

init?(user: String?, item: String?, number: NSNumber?, page: NSNumber?, filter: [AnyHashable : Any]?, getProperties: Bool, testEvents: [Any]?)

Parameters

`user`	User’s unique identifier. Used for discover-recommended and discover-recommended_similar.
`item`	Item’s unique identifier. Used for discover-similar and discover-recommended_similar.
`number`	Number of recommendations to return. Maximum of 500.
`page`	The page of recommended items to return.
`filter`	The filter to apply on the discoveries. See https://tamber.com/docs/api/#filtering and our filtering guide at https://tamber.com/docs/guides/filtering.html for reference.
`getProperties`	Include items’ properties and tags in the discovery objects.
`testEvents`	Recommendations will be made as if the supplied events had occurred, but the engine will not be affected in any way. Also works if the user that has not yet been created, allowing you to see what a visiting user’s recommendations would be. Warning: recommendations with test_events are generated at a lower priority of computational resources and are not representative of recommendation API performance.

Show on GitHub