AMAECommerceScreen class
This class contains screen information.
Instance methods
|
Initializes the instance of the |
|
|
Initializes the instance of the |
|
|
Initializes the instance of the |
|
|
Initializes the instance of the |
|
|
Initializes the instance of the |
Properties
|
Screen name. Acceptable sizes: Up to 100 characters. |
|
|
The path to the screen by category. |
|
|
Search query. Allowed size: Up to 1000 characters. |
|
|
Additional information about the screen. |
Method descriptions
-initWithName:
- (instancetype)initWithName:(NSString *)name
Initializes the instance of the AMAECommerceScreen class with the specified screen name.
Parameters:
|
|
Screen name. Acceptable sizes: Up to 100 characters. |
Returns:
The AMAECommerceScreen class instance.
-initWithCategoryComponents:
(instancetype)initWithCategoryComponents:(NSArray<NSString *> *)categoryComponents
Initializes the instance of the AMAECommerceScreen class with the specified path to the screen.
Parameters:
|
|
The path to the screen by category. Acceptable sizes:
|
Returns:
The AMAECommerceScreen class instance.
-initWithSearchQuery:
- (instancetype)initWithSearchQuery:(NSString *)searchQuery
Initializes the instance of the AMAECommerceScreen class with the specified search query.
Parameters:
|
|
Search query. Allowed size: Up to 1000 characters. |
Returns:
The AMAECommerceScreen class instance.
-initWithPayload:
- (instancetype)initWithPayload:(NSDictionary<NSString *, NSString *> *)payload;
Initializes the instance of the AMAECommerceScreen class with the specified additional information.
Parameters:
|
|
Additional information about the screen. Acceptable sizes:
|
Returns:
The AMAECommerceScreen 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 AMAECommerceScreen class with all parameters.
Parameters:
|
|
Screen name. Acceptable sizes: Up to 100 characters. |
|
|
The path to the screen by category. Acceptable sizes:
|
|
|
Search query. Allowed size: Up to 1000 characters. |
|
|
Additional information about the screen. Acceptable sizes:
|
Returns:
The AMAECommerceScreen 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
payloadsize: Up to 20 KB. - The
keysize: Up to 100 characters. - The
valuesize: Up to 1000 characters.