TMBDiscoverParams Class Reference


                    
                    
                    +discoverRecommended:

The simplest way to get TMBDiscoverParams 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)discoverRecommended:(nullable NSNumber *)number;

Swift

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

Parameters


                                number

Number of recommendations to return.

Show on GitHub


                    
                    
                    +discoverRecommended:getProperties:

Get TMBDiscoverParams for user recommendations with given number of recommended items (TMBDiscovery objects) you want to return, and getProperties set to given value (set to true to include item properties in returned TMBDiscovery objects).

Warning

The TMBClient userId must be set with setUser.

Declaration

Objective-C

+ (nullable instancetype)discoverRecommended:(nullable NSNumber *)number
                               getProperties:(BOOL)getProperties;

Swift

class func discoverRecommended(_ number: NSNumber?, getProperties: Bool) -> Self?

Parameters

`number`	Number of recommendations to return.
`getProperties`	Include items’ properties and tags in the discovery objects.

Show on GitHub


                    
                    
                    +discoverRecommended:excludeItems:variability:filter:getProperties:continuation:noCreate:

Expanded discover params for recommendations.

Declaration

Objective-C

+ (nullable instancetype)discoverRecommended:(nullable NSNumber *)number
                                excludeItems:(nullable NSArray *)excludeItems
                                 variability:(nullable NSNumber *)variability
                                      filter:(nullable NSDictionary *)filter
                               getProperties:(BOOL)getProperties
                                continuation:(BOOL)continuation
                                    noCreate:(nullable NSString *)noCreate;

Swift

class func discoverRecommended(_ number: NSNumber?, excludeItems: [Any]?, variability: NSNumber?, filter: [AnyHashable : Any]?, getProperties: Bool, continuation: Bool, noCreate: String?) -> Self?

Parameters

`number`	Number of recommendations to return. Maximum of 200.
`excludeItems`	List of item ids to exclude from results. Useful for hiding items that are already being displayed to the user.
`variability`	Represents the degree of variability applied to the results. variability helps make results more dynamic, and is intelligently weighted to prioritize higher-scoring results (i.e. it does not just shuffle the results). Defaults to 0 if not supplied.
`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.
`continuation`	Auto-continue from last discover-next or discover-recommended request for the given user. Allows you to ‘show more’ or implement infinite scrolling.
`noCreate`	Disables automatic creation of novel users and/or items. Set to `user` to disable user creation, `item` to disable item creation, or `user,item` to disable both user and item creation.

Show on GitHub


                    
                    
                    +discoverNext:number:

The simplest way to get TMBDiscoverParams for up-next for a given item page. If TMBClient userId has been set, the results will be tuned for the user.

Declaration

Objective-C

+ (nullable instancetype)discoverNext:(nullable NSString *)item
                               number:(nullable NSNumber *)number;

Swift

class func discoverNext(_ item: String?, number: NSNumber?) -> Self?

Parameters

`item`	Item’s unique identifier.
`number`	Number of recommendations to return.

Show on GitHub


                    
                    
                    +discoverNext:number:getProperties:

The simplest way to get TMBDiscoverParams for a given item. If TMBClient userId has been set, the results will be tuned for the user.

Declaration

Objective-C

+ (nullable instancetype)discoverNext:(nullable NSString *)item
                               number:(nullable NSNumber *)number
                        getProperties:(BOOL)getProperties;

Swift

class func discoverNext(_ item: String?, number: NSNumber?, getProperties: Bool) -> Self?

Parameters

`item`	Item’s unique identifier.
`number`	Number of recommendations to return.
`getProperties`	Include items’ properties and tags in the discovery objects.

Show on GitHub


                    
                    
                    +discoverNext:number:excludeItems:variability:filter:getProperties:noCreate:

Expanded discover params for up-next suggestions.

Declaration

Objective-C

+ (nullable instancetype)discoverNext:(nullable NSString *)item
                               number:(nullable NSNumber *)number
                         excludeItems:(nullable NSArray *)excludeItems
                          variability:(nullable NSNumber *)variability
                               filter:(nullable NSDictionary *)filter
                        getProperties:(BOOL)getProperties
                             noCreate:(nullable NSString *)noCreate;

Swift

class func discoverNext(_ item: String?, number: NSNumber?, excludeItems: [Any]?, variability: NSNumber?, filter: [AnyHashable : Any]?, getProperties: Bool, noCreate: String?) -> Self?

Parameters

`item`	Item’s unique identifier.
`number`	Number of recommendations to return. Maximum of 200.
`excludeItems`	List of item ids to exclude from results. Useful for hiding items that are already being displayed to the user.
`variability`	Represents the degree of variability applied to the results. variability helps make results more dynamic, and is intelligently weighted to prioritize higher-scoring results (i.e. it does not just shuffle the results). Defaults to 0 if not supplied.
`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.
`noCreate`	Disables automatic creation of novel users and/or items. Set to `user` to disable user creation, `item` to disable item creation, or `user,item` to disable both user and item creation.

Show on GitHub


                    
                    
                    +discoverNextParamsWithUser:number:

DiscoverNext params for user recommendations.

Declaration

Objective-C

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

Swift

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

Parameters

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

Show on GitHub


                    
                    
                    +discoverNextParamsWithUser:item:number:

DiscoverNext params for user-item recommendations.

Declaration

Objective-C

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

Swift

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

Parameters

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

Show on GitHub


                    
                    
                    -initWithUser:item:number:excludeItems:variability:filter:getProperties:continuation:noCreate:

Initialize discover params for user recommendations.

Declaration

Objective-C

- (nullable instancetype)initWithUser:(nullable NSString *)user
                                 item:(nullable NSString *)item
                               number:(nullable NSNumber *)number
                         excludeItems:(nullable NSArray *)excludeItems
                          variability:(nullable NSNumber *)variability
                               filter:(nullable NSDictionary *)filter
                        getProperties:(BOOL)getProperties
                         continuation:(BOOL)continuation
                             noCreate:(nullable NSString *)noCreate;

Swift

init?(user: String?, item: String?, number: NSNumber?, excludeItems: [Any]?, variability: NSNumber?, filter: [AnyHashable : Any]?, getProperties: Bool, continuation: Bool, noCreate: String?)

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 200.
`excludeItems`	List of item ids to exclude from results. Useful for hiding items that are already being displayed to the user.
`variability`	Represents the degree of variability applied to the results. Variability helps make results more dynamic, and is intelligently weighted to prioritize higher-scoring results (i.e. it does not just shuffle the results). Defaults to 0 if not supplied.
`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.
`noCreate`	Disables automatic creation of novel users and/or items. Set to `user` to disable user creation, `item` to disable item creation, or `user,item` to disable both user and item creation.

Show on GitHub


                    
                    
                    excludeItems

List of item ids to exclude from results. Useful for hiding items that are already being displayed to the user.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) NSArray *excludeItems;

Swift

var excludeItems: [Any]? { get }

Show on GitHub


                    
                    
                    variability

Represents the degree of variability applied to the results. Variability helps make results more dynamic, and is intelligently weighted to prioritize higher-scoring results (i.e. it does not just shuffle the results). Defaults to 0 if not supplied.

Declaration

Objective-C

@property (nonatomic, nullable) NSNumber *variability;

Swift

var variability: NSNumber? { get set }

Show on GitHub