YMMECommerceScreen class

This class contains screen information.

Instance methods

init(name:)

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

init(categoryComponents:)

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

init(searchQuery:)

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

init(payload:)

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

init(name:categoryComponents:searchQuery:payload:)

Initializes the instance of the YMMECommerceScreen class with all parameters.

init(name:)

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

init(categoryComponents:)

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

init(searchQuery:)

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

init(payload:)

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

init(name:categoryComponents:searchQuery:payload:)

Initializes the instance of the YMMECommerceScreen class with all parameters.

Properties

name

Screen name. Allowed size: 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. Allowed size: 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

init(name:)

init(name: String)

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

Parameters:
name

Screen name. Allowed size: Up to 100 characters.

name

Screen name. Allowed size: Up to 100 characters.

Returns:

The YMMECommerceScreen class instance.

init(categoryComponents:)

init(categoryComponents: [String])

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.

init(searchQuery:)

init(searchQuery: String)

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.

init(payload:)

init(payload: [String: String])

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.

init(name:categoryComponents:searchQuery:payload:)

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

Initializes the instance of the YMMECommerceScreen class with all parameters.

Parameters:
name

Screen name. Allowed size: 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. Allowed size: 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

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.