ECommerceScreen class

This class contains screen information.

Instance methods

Properties

Method descriptions

init(name:)

init(name: String)

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

Parameters:

Returns:

The ECommerceScreen class instance.

init(categoryComponents:)

init(categoryComponents: [String])

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

Parameters:

Returns:

The ECommerceScreen class instance.

init(searchQuery:)

init(searchQuery: String)

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

Parameters:

Returns:

The ECommerceScreen class instance.

init(payload:)

init(payload: [String: String])

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

Parameters:

Returns:

The ECommerceScreen class instance.

init(name:categoryComponents:searchQuery:payload:)

init(name: String?, categoryComponents: [String]?, searchQuery: String?, payload: [String: String]?)

Initializes the instance of the ECommerceScreen class with all parameters.

Parameters:

Returns:

The ECommerceScreen class instance.

Property descriptions

name

var name: String? { get }

Screen name. Allowed size: Up to 100 characters.

categoryComponents

var categoryComponents: [String]? { get }

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

var searchQuery: String? { get }

Search query. Allowed size: Up to 1000 characters.

payload

var payload: [String: String]? { get }

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.