class

ActivityTracker

Extends: Hashable

public static func == (lhs: ActivityTracker, rhs: ActivityTracker) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

public convenience init(
    platformContext: Context,
    model: Model,
    speedBound: Double = 4.2,
    timeThreshold: TimeInterval = 20
)

Расширение навигатора, которое отслеживает активность пользователя и выдает сигнал, когда пользователь перестал пользоваться навигатором и его можно выключить.

Parameters

platformContext

Context

Контекст.

model

Model

Модель навигатора, состояние которого отслеживается.

speedBound

Double

Верхняя граница скорости в м/с, при превышении которой в состоянии Finished навигатора считается, что навигатор активен, т.е. движение продолжается.

timeThreshold

TimeInterval

Время, в течение которого в состоянии Finished навигатора отслеживается скорость движения ниже пороговой для определения состояния неактивности навигатора. Если в течение этого времени скорость движения меньше установленного порога или нет данных о локации и скорости, навигатор считается неактивным.

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var stopChannel

StatefulChannel<Bool>

Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.

var stop

Bool

Флаг, активное состояние которого указывает на то, что навигатор необходимо остановить. Если в состоянии Finished навигация прекращается, т.е. движение останавливается или его скорость становится ниже порогового значения, и если такое состояние сохраняется некоторое время, то устанавливается флаг устанавливается в true, в противном случае он имеет значение false.

AlternativeRouteSelector

Выбор альтернативного маршрута.

Extends: Hashable

public static func == (lhs: AlternativeRouteSelector, rhs: AlternativeRouteSelector) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func selectAlternativeRoute(
    trafficRoute: TrafficRoute
)

Выбор альтернативного маршрута. Если переданный маршрут не соответствует одному из актуальных альтернативных маршрутов, ничего не происходит. В противном случае соответствующий альтернативный маршрут становится текущим активным маршрутом.

Parameters

trafficRoute

TrafficRoute

Альтернативный маршрут, который должен быть выбран в качестве текущего активного маршрута.

AlternativeRoutesProviderSettings

Настройки поиска альтернативных маршрутов и маршрута лучше.

Extends: Hashable

public static func == (lhs: AlternativeRoutesProviderSettings, rhs: AlternativeRoutesProviderSettings) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var alternativeRoutesEnabled

Bool

Флаг включения/выключения предложения альтернативных маршрутов. По умолчанию предложение альтернативных маршрутов включено.

var betterRouteEnabled

Bool

Флаг включения/выключения предложения маршрута лучше. По умолчанию предложение маршрута лучше включено.

var routeSearchDelay

Double

Задержка перед поиском альтернативных маршрутов при старте поездки по маршруту или после перехода на какой-либо другой маршрут. Должна быть не меньше 5 секунд. По умолчанию 20 секунд.

var onAlternativeRoutesSuggestedRouteSearchDelay

Double

Задержка перед следующим поиском маршрутов сразу после предложения пользователю альтернативных маршрутов. Сбрасывается в случае, если после предложения альтернативных маршрутов пользователь переходит на любой другой маршрут помимо одного из предложенных альтернативных.

var betterRouteTimeCostThreshold

Double

Минимальная разница во времени движения между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.

var betterRouteLengthThreshold

RouteDistance

Минимальная суммарная длина рёбер маршрута, которые отличаются между исходным маршрутом и альтернативным маршрутом, при которой альтернативный маршрут считается маршрутом лучше.

var routerType

RouterType

Тип поисковика для поиска альтернативных маршрутов.

AnimationSettings

Настройки анимаций объектов карты. Применяются для слоев стилей, в которых указан источник модели. Например, такими слоями являются слои с типами “3D model” и “Directional model”. Индекс анимации должен быть обязательно указан для анимированной модели.

Extends: Hashable

public static func == (lhs: AnimationSettings, rhs: AnimationSettings) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var animationIndex

Int32?

Индекс текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, никакая анимация не проигрывается.

var animationName

String?

Название текущей анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано, никакая анимация не проигрывается.

var sceneIndex

Int32?

Индекс текущей сцены модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, используется сцена по умолчанию, которая определена в самой модели.

var sceneName

String?

Название текущей сцены модели. Если null, то используется значение из стилей. Если в стилях значение не задано, используется сцена по умолчанию, которая определена в самой модели.

var animationRepeatCount

Int32?

Количество повторений анимации модели. Если null, то используется значение из стилей. Если в стилях значение не задано или задано отрицательное, анимация будет проигрываться бесконечно.

var animationSpeed

Float?

Скорость проигрывания анимации модели. Если null, то используется значение из стилей. Значения больше единицы ускоряют проигрывание, меньше замедляют. Если в стилях значение не задано, используется скорость по умолчанию.

Attributes

Интерфейс для управления свойствами объекта карты.

Extends: Hashable

public static func == (lhs: Attributes, rhs: Attributes) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func setAttributeValue(
    name: String,
    value: AttributeValue
)

Установка свойства.

Parameters

name

String

Название свойства.

value

AttributeValue

Значение.

public nonisolated func setAttributeValues(
    values: [String: AttributeValue],
    attributesToRemove: [String] = []
)

Установка набора свойств. Сначала удаляются свойства attributes_to_remove, затем добавляются свойства values. Если свойство с таким названием уже было добавлено, то оно заменяется.

Parameters

values

String[ : ]

Набор пар “имя”:“значение” для добавляемых свойства.

attributesToRemove

String[]

Список имён свойств, которые нужно удалить.

public nonisolated func removeAttribute(
    name: String
)

Удаление свойства.

Parameters

name

String

Имя свойства для удаления.

public nonisolated func getAttributeValue(
    name: String
) -> AttributeValue

Получение свойства.

Parameters

name

String

Имя свойства для получения.

Returns

AttributeValue

Properties

var attributeNames

[String]

Получение списка свойств.

var changed

Channel<[String]>

Получение канала, уведомляющего об изменении свойств.

AudioSettings

Класс для управления звуком.
Все методы могут вызываться из любого потока.

Extends: Hashable

public static func == (lhs: AudioSettings, rhs: AudioSettings) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public static nonisolated func `get`(
    context: Context
) -> AudioSettings?

Настройки аудио. Null, если аудио драйвер недоступен.

Parameters

context

Context

Returns

AudioSettings?

Properties

var volume

UInt32

Уровень громкости звука (0-100).

var mute

Bool

Проигрывание звука отключено.

var audioFocusPolicy

AudioFocusPolicy

Поведения звуков других приложений при запрошенном фокусе.

BaseCamera

Камера.

Extends: Hashable

public static func == (lhs: BaseCamera, rhs: BaseCamera) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func clone() -> BaseCamera

Создание копии текущей камеры.

Returns

BaseCamera

public nonisolated func setPosition(
    position: CameraPosition
) throws

Установка новой позиции камеры.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за позицией, стилевым уровнем масштабирования, наклоном и направлением.

Parameters

position

CameraPosition

public nonisolated func changePosition(
    positionChange: CameraPositionChange
) throws

Изменение только части параметров позиции камеры.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за изменёнными параметрами, а при изменении координат также и слежение за стилевым уровнем масштабирования и направлением.

Parameters

positionChange

CameraPositionChange

public nonisolated func setZoomRestrictions(
    zoomRestrictions: CameraZoomRestrictions
) throws

Функция устанавливает новый диапазон ограничений уровня масштабирования.

Parameters

zoomRestrictions

CameraZoomRestrictions

Новый диапазон ограничений уровня масштабирования.

public nonisolated func setPositionPoint(
    positionPoint: CameraPositionPoint
) throws

Функция устанавливает новую позицию относительно области экрана, ограниченной отступами.

Parameters

positionPoint

CameraPositionPoint

новая позиция относительно области экрана, ограниченной отступами.

public nonisolated func setViewPoint(
    viewPoint: CameraViewPoint?
) throws

Функция устанавливает новую точку взгляда относительно полного размера вьюпорта.

Parameters

viewPoint

CameraViewPoint?

новая точка взгляда относительно полного размера вьюпорта. Будет следовать за точкой позиции, если передан nil.

Properties

var projection

Projection

Проекция.

var position

CameraPosition

Получение текущей позиции камеры.

var zoomRestrictions

CameraZoomRestrictions

Получение актуальных ограничений уровня масштабирования.

var deviceDensity

DeviceDensity

Получение отношения DPI к базовому DPI устройства.

var size

ScreenSize

Получение размера области просмотра.

var padding

Padding

Получение текущих отступов от краёв экрана.

var positionPoint

CameraPositionPoint

Точка экрана, к которой привязана позиция камеры, задаётся с учётом отступов (padding).

var viewPoint

CameraViewPoint?

Точка взгляда относительно полного размера вьюпорта.

var visibleArea

Geometry

Область пересечения пирамиды видимости камеры и поверхности карты.

var visibleRect

GeoRect

Объемлющий прямоугольник видимой области карты.

var maxTiltRestriction

(any StyleZoomToTiltRelation)?

Получение текущей функции зависимости максимального угла наклона камеры от стилевого уровня масштабирования.

var viewportRestriction

GeoRect?

Получение ограничения на область видимости.

var changed

Channel<CameraChange>

Получение причин изменения состояния камеры.
Измененные свойства доступны в соответствующих каналах.

BearingFollowController

Контроллер слежения за направлением карты.

Extends: FollowController

public convenience init(
    bearingSource: BearingSource,
    animationDuration: TimeInterval = 1,
    valueThreshold: Bearing = Bearing(value: 1)
)

Создание контроллера слежения за направлением карты.

Parameters

bearingSource

BearingSource

источник информации о направлении.

animationDuration

TimeInterval

неотрицательная длительность изменения реального направления.

valueThreshold

Bearing

неотрицательное пороговое значение учитываемого изменения реального направления.

BoolRouteLongAttribute

Контейнер, который хранит протяженный атрибут маршрута. Каждый элемент хранится в виде пары, состоящей из точки и значения элемента атрибута. Действие атрибута начинается с данной точки и заканчивается в следущей точке, начиная с которой начинается действие атрибута следующего элемента.

Extends: Hashable

public static func == (lhs: BoolRouteLongAttribute, rhs: BoolRouteLongAttribute) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func entry(
    point: RoutePoint
) -> BoolRouteLongEntry?

Элемент, в который попадает заданная точка.

Parameters

point

RoutePoint

Returns

BoolRouteLongEntry?

public nonisolated func entries(
    begin: RoutePoint,
    end: RoutePoint
) -> [BoolRouteLongEntry]

Элементы, частично или полностью покрываемые отрезком [begin, end].

Parameters

begin

RoutePoint

end

RoutePoint

Returns

BoolRouteLongEntry[]

Properties

var size

UInt64

Количество элементов.

var isEmpty

Bool

Элементы отсутствуют.

var first

BoolRouteLongEntry?

Первый элемент.

var last

BoolRouteLongEntry?

Последний элемент.

var entries

[BoolRouteLongEntry]

Все элементы.

BufferedChannel

Extends: Channel<Value>

Properties

var value

Value?

Camera

Камера для запуска перемещения карты и настроек слежения.

Extends: BaseCamera

Methods

public nonisolated func move(
    moveController: CameraMoveController
) -> Future<CameraAnimatedMoveResult>

Запуск перемещения карты.
Сбрасывает текущий режим слежения карты и прерывает обработку жестов.

Parameters

moveController

CameraMoveController

Контроллер анимированного перемещения камеры.

Returns

Future<>

public nonisolated func move(
    position: CameraPosition,
    time: TimeInterval = 0.3,
    animationType: CameraAnimationType = CameraAnimationType.`default`
) -> Future<CameraAnimatedMoveResult>

Запуск анимированного перемещения карты с использованием встроенного контроллера перемещений карты.
Сбрасывает слежение за позицией, уровнем масштабирования, наклоном и направлением и прерывает обработку жестов.

Parameters

position

CameraPosition

Конечная позиция камеры.

time

TimeInterval

Время, выделенное на перемещение карты.

animationType

CameraAnimationType

Тип анимации при перемещении камеры.

Returns

Future<>

public nonisolated func move(
    point: GeoPoint,
    zoom: Zoom,
    tilt: Tilt?,
    bearing: Bearing,
    time: TimeInterval = 0.3,
    animationType: CameraAnimationType = CameraAnimationType.`default`
) -> Future<CameraAnimatedMoveResult>

Запуск анимированного перемещения карты с использованием встроенного контроллера перемещений карты.

Parameters

point

GeoPoint

точка конечной позиции камеры

zoom

Zoom

уровень масштабирования в конечной позиции камеры

tilt

Tilt?

наклон в конечной позиции камеры или пустое значение, если нужно в зависимости от активного режима слежения использовать значение из follow controller’а или текущее значение

bearing

Bearing

поворот в конечной позиции камеры

time

TimeInterval

время, выделенное на перемещение карты

animationType

CameraAnimationType

тип анимации при перемещении камеры

Returns

Future<>

public nonisolated func processMovementAndStop()

Установка позиции камеры в соответствие с текущим временем и прекращение анимированного перемещения.
Вызов прерывает перелёт и обработку жестов, а также сбрасывает слежение за позицией, уровнем масштабирования и направлением.

public nonisolated func setBehaviour(
    behaviour: CameraBehaviour
)

Смена режима слежения камеры. Если новый режим более ограниченный, чем текущий, вызов прервёт перелёт и обработку жестов.

Parameters

behaviour

CameraBehaviour

public nonisolated func addFollowController(
    followController: FollowController
)

Добавление контроллера слежения.

Parameters

followController

FollowController

public nonisolated func removeFollowController(
    followController: FollowController
)

Удаление контроллера слежения.

Parameters

followController

FollowController

public nonisolated func setCustomFollowController(
    followController: CustomFollowController
)

Добавление контроллера слежения, реализованного на платформе.

Parameters

followController

CustomFollowController

public nonisolated func removeCustomFollowController()

Удаление контроллера слежения, реализованного на платформе.

func setPosition(point: GeoPoint, zoom: Zoom) throws

Parameters

point

GeoPoint

zoom

Zoom

func setPosition(point: GeoPoint) throws

Parameters

point

GeoPoint

func sinkOnStatefulChangesOnMainThread<T: Sendable>(
	reason: CameraChangeReasonOptionSet,
	receiveValue: @escaping @Sendable (T) -> Void
) -> Cancellable

Подписаться на получение результата из Channel с указанием типа изменения на main очереди. При подписке получает начальное значение из Camera, соответствующему переданному CameraChangeReasonOptionSet.

Parameters

reason

CameraChangeReasonOptionSet

Returns

Cancellable

func sinkOnStatefulChanges<T: Sendable>(
	on queue: DispatchQueue,
	reason: CameraChangeReasonOptionSet,
	receiveValue: @escaping @Sendable (T) -> Void
) -> Cancellable

Подписаться на получение результата из Channel с указанием типа изменения на заданной очереди. При подписке получает начальное значение из Camera, соответствующему переданному CameraChangeReasonOptionSet.

Parameters

queue

DispatchQueue

reason

CameraChangeReasonOptionSet

Returns

Cancellable

Properties

var state

CameraState

Получение актуального состояния камеры.

var behaviour

CameraBehaviourChange

Режим слежения камеры.

CameraNotifier

Предупреждает о попадании в зону действия дорожной камеры.

Extends: Hashable

public static func == (lhs: CameraNotifier, rhs: CameraNotifier) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

public convenience init(
    model: Model
)

Расширение навигатора, которое предупреждает о попадании в зону действия дорожной камеры.

Parameters

model

Model

Модель навигатора, состояние которого отслеживается.

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var cameraProgressChannel

StatefulChannel<CameraProgressInfo?>

Прогресс прохождения зоны действия дорожной камеры.

var cameraProgress

CameraProgressInfo?

Прогресс прохождения зоны действия дорожной камеры.

CameraRouteAttribute

Контейнер, который описывает точечный атрибут маршрута. Каждый элемент хранится в виде точки на маршруте, в которой этот элемент расположен и значения самого элемента.

Extends: Hashable

public static func == (lhs: CameraRouteAttribute, rhs: CameraRouteAttribute) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func entries(
    begin: RoutePoint,
    end: RoutePoint
) -> [CameraRouteEntry]

Элементы, попадающие в отрезок [begin, end).

Parameters

begin

RoutePoint

end

RoutePoint

Returns

CameraRouteEntry[]

public nonisolated func findNearBackward(
    point: RoutePoint
) -> CameraRouteEntry?

Найти ближайший элемент, позиция которого < = point.
Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

CameraRouteEntry?

public nonisolated func findNearForward(
    point: RoutePoint
) -> CameraRouteEntry?

Найти ближайший элемент, позиция которого >= point.
Сложность операции log2(N), где N = size.

Parameters

point

RoutePoint

Returns

CameraRouteEntry?

Properties

var size

UInt64

Количество элементов.

var isEmpty

Bool

Элементы отсутствуют.

var first

CameraRouteEntry?

Первый элемент.

var last

CameraRouteEntry?

Последний элемент.

var entries

[CameraRouteEntry]

Все элементы.

CameraTransactionGuard

Extends: Hashable

public static func == (lhs: CameraTransactionGuard, rhs: CameraTransactionGuard) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

CancelEvent

Событие отмены текущего действия.

Extends: Event

public convenience init()

Cancellable

A cancellation token for a running operation.

Implements: ICancellable

public init(
	cancel: @escaping () -> Void,
	release: @escaping () -> Void = {}
)

public convenience init()

Make a cancellation token that cancels nothing.

public static func ==(lhs: Cancellable, rhs: Cancellable) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func cancel()

May be called any number of times from any queue.

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

CategoriesPage

Страница результатов запроса категорий.

Extends: Hashable

public static func == (lhs: CategoriesPage, rhs: CategoriesPage) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func fetchPrevPage() -> Future<CategoriesPage?>

Получить предыдущую страницу результатов.

public nonisolated func fetchNextPage() -> Future<CategoriesPage?>

Получить следующую страницу результатов.

Properties

var items

[Category]

Категории этой страницы.

Category

Категория справочника.

Extends: Hashable

public static func == (lhs: Category, rhs: Category) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

Properties

var id

RubricId

Идентификатор категории.

var type

CategoryType

Тип категории.

var name

String

Название категории.

var alias

String

Транслитерированное название категории.
при отсутствии может быть пустой строкой.

var title

String

Заголовок для отображения в UI.
при отсутствии может быть пустой строкой.

var caption

String

Короткая подпись к иконке для отображения в UI.
при отсутствии может быть пустой строкой.

var seoName

String

SEO-синоним.
при отсутствии может быть пустой строкой.

var keyword

String

Ключевое слово, по которому была найдена категория.
при отсутствии может быть пустой строкой.

var tag

String

Уникальное имя, которое можно использовать как часть имени файла-иконки.
при отсутствии может быть пустой строкой.

var iconUrl

String

Ссылка на изображение.
при отсутствии может быть пустой строкой.

var suggestIcon

String

Иконка категории для выдачи suggest.
при отсутствии может быть пустой строкой.

var parentId

RubricId?

Идентификатор родительской категории.
при отсутствии может быть пустой строкой.

var branchCount

UInt64

Количество филиалов организаций в данной категории.

var orgCount

UInt64

Количество организаций в данной категории.

var geoCount

UInt64

Количество геообъектов в данной категории.

var isReviewableOnFlamp

Bool

Разрешены ли отзывы к организациям этой категории непосредственно на flamp.ru.

var children

[Category]

Дочерние категории.

CategoryGetByIdsQueryBuilder

Построитель запроса получения категорий по идентификаторам.

Extends: Hashable

public static func == (lhs: CategoryGetByIdsQueryBuilder, rhs: CategoryGetByIdsQueryBuilder) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

public convenience init(
    ids: [RubricId]
)

Начать построение запроса получения категорий по идентификаторам.

Parameters

ids

RubricId[]

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func setGeoContext(
    geoContext: CategoryGeoContext?
) -> CategoryGetByIdsQueryBuilder

Задать географический контекст запроса. Если не задан, то география будет определяться с помощью LocationService.

Parameters

geoContext

CategoryGeoContext?

Returns

CategoryGetByIdsQueryBuilder

public nonisolated func setLocale(
    locale: Locale?
) -> CategoryGetByIdsQueryBuilder

Задать локаль для запроса категорий.

Parameters

locale

Locale?

Returns

CategoryGetByIdsQueryBuilder

public nonisolated func build() -> CategoryQuery

Сформировать запрос категорий.

Returns

CategoryQuery

CategoryListQueryBuilder

Построитель запроса списка категорий.

Extends: Hashable

public static func == (lhs: CategoryListQueryBuilder, rhs: CategoryListQueryBuilder) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

public convenience init()

Начать построение запроса списка категорий.

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

public nonisolated func setParentId(
    parentId: RubricId?
) -> CategoryListQueryBuilder

Задать родителя для запроса списка категорий.

Parameters

parentId

RubricId?

Returns

CategoryListQueryBuilder

public nonisolated func setSortType(
    sortType: CategorySortType
) -> CategoryListQueryBuilder

Задать сортировку для запроса списка категорий.

Parameters

sortType

CategorySortType

Returns

CategoryListQueryBuilder

public nonisolated func setGeoContext(
    geoContext: CategoryGeoContext?
) -> CategoryListQueryBuilder

Задать географический контекст запроса. Если не задан, то география будет определяться с помощью LocationService.

Parameters

geoContext

CategoryGeoContext?

Returns

CategoryListQueryBuilder

public nonisolated func setPageSize(
    pageSize: UInt32
) -> CategoryListQueryBuilder

Задать размер страницы.

Parameters

pageSize

UInt32

Returns

CategoryListQueryBuilder

public nonisolated func setLocale(
    locale: Locale?
) -> CategoryListQueryBuilder

Задать локаль для запроса категорий.

Parameters

locale

Locale?

Returns

CategoryListQueryBuilder

public nonisolated func build() -> CategoryQuery

Сформировать запрос категорий.

Returns

CategoryQuery

CategoryQuery

Запрос категорий.

Extends: Hashable

public static func == (lhs: CategoryQuery, rhs: CategoryQuery) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

Methods

public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.
This documentation comment was inherited from .

Parameters

hasher

Hasher

The hasher to use when combining the components of this instance.

CategorySearchQueryBuilder

Построитель запроса поиска категорий по тексту.

Extends: Hashable

public static func == (lhs: CategorySearchQueryBuilder, rhs: CategorySearchQueryBuilder) -> Bool

Returns a Boolean value indicating whether two values are equal.
This documentation comment was inherited from .

public convenience init(
    queryText: String
)

Начать построение запроса поиска категорий по тексту.

Parameters

queryText

String