YMMECommerceScreen class

This class contains screen information.

Instance methods

-initWithName:

Initializes the instance of the YMMECommerceScreen class with the specified screen name.
-initWithCategoryComponents:

Initializes the instance of the YMMECommerceScreen class with the specified path to the screen.
-initWithSearchQuery:

Initializes the instance of the YMMECommerceScreen class with the specified search query.
-initWithPayload:

Initializes the instance of the YMMECommerceScreen class with the specified additional information.
-initWithName:categoryComponents:searchQuery:payload:

Initializes the instance of the YMMECommerceScreen class with all parameters.
-initWithName:

Initializes the instance of the YMMECommerceScreen class with the specified screen name.
-initWithCategoryComponents:

Initializes the instance of the YMMECommerceScreen class with the specified path to the screen.
-initWithSearchQuery:

Initializes the instance of the YMMECommerceScreen class with the specified search query.
-initWithPayload:

Initializes the instance of the YMMECommerceScreen class with the specified additional information.
-initWithName:categoryComponents:searchQuery:payload:

Initializes the instance of the YMMECommerceScreen class with all parameters.

Properties

name

Screen name. Acceptable sizes: Up to 100 characters.
categoryComponents
The path to the screen by category. Acceptable sizes:
  • Up to 10 elements.
  • The size of a single element is up to 100 characters.
searchQuery

Search query. Allowed size: Up to 1000 characters.
payload
Additional information about the screen. Acceptable sizes:
  • The total payload size: Up to 20 KB.
  • The key size: Up to 100 characters.
  • The value size: Up to 1000 characters.
name

Screen name. Acceptable sizes: Up to 100 characters.
categoryComponents
The path to the screen by category. Acceptable sizes:
  • Up to 10 elements.
  • The size of a single element is up to 100 characters.
searchQuery

Search query. Allowed size: Up to 1000 characters.
payload
Additional information about the screen. Acceptable sizes:
  • The total payload size: Up to 20 KB.
  • The key size: Up to 100 characters.
  • The value size: Up to 1000 characters.

Method descriptions

-initWithName:

- (instancetype)initWithName:(NSString *)name

Initializes the instance of the YMMECommerceScreen class with the specified screen name.

Parameters:
name

Screen name. Acceptable sizes: Up to 100 characters.
name

Screen name. Acceptable sizes: Up to 100 characters.

Returns:

The YMMECommerceScreen class instance.

-initWithCategoryComponents:

(instancetype)initWithCategoryComponents:(NSArray<NSString *> *)categoryComponents

Initializes the instance of the YMMECommerceScreen class with the specified path to the screen.

Parameters:
categoryComponents
The path to the screen by category. Acceptable sizes:
  • Up to 10 elements.
  • The size of a single element is up to 100 characters.
categoryComponents
The path to the screen by category. Acceptable sizes:
  • Up to 10 elements.
  • The size of a single element is up to 100 characters.

Returns:

The YMMECommerceScreen class instance.

-initWithSearchQuery:

- (instancetype)initWithSearchQuery:(NSString *)searchQuery

Initializes the instance of the YMMECommerceScreen class with the specified search query.

Parameters:
searchQuery

Search query. Allowed size: Up to 1000 characters.
searchQuery

Search query. Allowed size: Up to 1000 characters.

Returns:

The YMMECommerceScreen class instance.

-initWithPayload:

- (instancetype)initWithPayload:(NSDictionary<NSString *, NSString *> *)payload;

Initializes the instance of the YMMECommerceScreen class with the specified additional information.

Parameters:
payload
Additional information about the screen. Acceptable sizes:
  • The total payload size: Up to 20 KB.
  • The key size: Up to 100 characters.
  • The value size: Up to 1000 characters.
payload
Additional information about the screen. Acceptable sizes:
  • The total payload size: Up to 20 KB.
  • The key size: Up to 100 characters.
  • The value size: Up to 1000 characters.

Returns:

The YMMECommerceScreen class instance.

‑initWithName:categoryComponents:searchQuery:payload:

- (instancetype)initWithName:(nullable NSString *)name
          categoryComponents:(nullable NSArray<NSString *> *)categoryComponents
                 searchQuery:(nullable NSString *)searchQuery
                     payload:(nullable NSDictionary<NSString *, NSString *> *)payload

Initializes the instance of the YMMECommerceScreen class with all parameters.

Parameters:
name

Screen name. Acceptable sizes: Up to 100 characters.
categoryComponents
The path to the screen by category. Acceptable sizes:
  • Up to 10 elements.
  • The size of a single element is up to 100 characters.
searchQuery

Search query. Allowed size: Up to 1000 characters.
payload
Additional information about the screen. Acceptable sizes:
  • The total payload size: Up to 20 KB.
  • The key size: Up to 100 characters.
  • The value size: Up to 1000 characters.
name

Screen name. Acceptable sizes: Up to 100 characters.
categoryComponents
The path to the screen by category. Acceptable sizes:
  • Up to 10 elements.
  • The size of a single element is up to 100 characters.
searchQuery

Search query. Allowed size: Up to 1000 characters.
payload
Additional information about the screen. Acceptable sizes:
  • The total payload size: Up to 20 KB.
  • The key size: Up to 100 characters.
  • The value size: Up to 1000 characters.

Returns:

The YMMECommerceScreen class instance.

Property descriptions

name

(nonatomic, copy, readonly, nullable) NSString *name

Screen name. Acceptable sizes: Up to 100 characters.

categoryComponents

(nonatomic, copy, readonly, nullable) NSArray<NSString *> *categoryComponents

The path to the screen by category. Acceptable sizes:
  • Up to 10 elements.
  • The size of a single element is up to 100 characters.

searchQuery

(nonatomic, copy, readonly, nullable) NSString *searchQuery

Search query. Allowed size: Up to 1000 characters.

payload

(nonatomic, copy, readonly, nullable) NSDictionary<NSString *, NSString *> *payload

Additional information about the screen. Acceptable sizes:
  • The total payload size: Up to 20 KB.
  • The key size: Up to 100 characters.
  • The value size: Up to 1000 characters.