SigmaUser.init
Набор методов для создания объекта SigmaUser, который необходим для инициализации SigmaClient.
SigmaUser.Builder.init
SigmaUser.Builder() -> SigmaUser.Builder
Создаёт Builder для объекта SigmaUser. После конфигурации свойств пользователя и вызова метода build(), возвращает объект SigmaUser.
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.setUserId
func setUserId(_ id: String) -> SigmaUser.Builder
Устанавливает userId для конструирумого объекта SigmaUser. Используется для раздачи экспериментов и фича-флагов. (если не назначен, то не будет работать сплит экспериментов по userId).
Параметры
| Name | Type | Required | Default | Description |
| id | String | Да | | userId пользователя |
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.setProfileId
func setProfileId(_ id: String) -> SigmaUser.Builder
Устанавливает profileId для конструирумого объекта SigmaUser. Используется для раздачи экспериментов и фича-флагов. (если не назначен, то не будет работать сплит экспериментов по profileId).
Параметры
| Name | Type | Required | Default | Description |
| id | String | Да | | profileId пользователя |
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.setDeviceId
func setDeviceId(_ id: String) -> SigmaUser.Builder
Устанавливает deviceId для конструирумого объекта SigmaUser. Используется для раздачи экспериментов и фича-флагов. Если не установлен, будет определен на стороне SDK.
Параметры
| Name | Type | Required | Default | Description |
| id | String | Да | | Переопределенный deviceId |
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.setEmail
func setEmail(_ email: String) -> SigmaUser.Builder
Устанавливает email для конструирумого объекта SigmaUser.
Параметры
| Name | Type | Required | Default | Description |
| email | String | Да | | email пользователя |
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.setAppVersion
func setAppVersion(_ version: String) -> SigmaUser.Builder
Устанавливает appVersion для конструирумого объекта SigmaUser. Если не установлен, будет определен на стороне SDK.
Параметры
| Name | Type | Required | Default | Description |
| version | String | Да | | Версия приложения |
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.setOsName
func setOsName(_ name: String) -> SigmaUser.Builder
Устанавливает os.name для конструирумого объекта SigmaUser. Если не установлен, будет определен на стороне SDK.
Параметры
| Name | Type | Required | Default | Description |
| name | String | Да | | Название операционной системы |
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.setOsVersion
func setOsVersion(_ version: String) -> SigmaUser.Builder
Устанавливает os.version для конструирумого объекта SigmaUser. Если не установлен, будет определен на стороне SDK.
Параметры
| Name | Type | Required | Default | Description |
| version | String | Да | | Версия операционной системы |
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.setGeoCode
func setGeoCode(_ code: String) -> SigmaUser.Builder
Устанавливает geo.code для конструирумого объекта SigmaUser. Если не установлен, будет определен на стороне SDK.
Параметры
| Name | Type | Required | Default | Description |
| code | String | Да | | Гео код |
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.setGeoCountry
func setGeoCountry(_ country: String) -> SigmaUser.Builder
Устанавливает geo.country для конструирумого объекта SigmaUser. Если не установлен, будет определен на стороне SDK.
Параметры
| Name | Type | Required | Default | Description |
| country | String | Да | | Страна |
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.setGeoState
func setGeoState(_ state: String) -> SigmaUser.Builder
Устанавливает geo.state для конструирумого объекта SigmaUser. Если не установлен, будет определен на стороне SDK.
Параметры
| Name | Type | Required | Default | Description |
| state | String | Да | | Регион |
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.setGeoCity
func setGeoCity(_ city: String) -> SigmaUser.Builder
Устанавливает geo.city для конструирумого объекта SigmaUser. Если не установлен, будет определен на стороне SDK.
Параметры
| Name | Type | Required | Default | Description |
| city | String | Да | | Город |
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.setCustomProperty
func setCustomProperty<Value: CustomStringConvertible>(_ value: Value, key: String) -> SigmaUser.Builder
Устанавливает значение кастомного параметра для конструирумого объекта SigmaUser.
Параметры
| Name | Type | Required | Default | Description |
| value | CustomStringConvertible | Да | | Значение кастомного параметра |
| key | String | Да | | Ключ кастомного параметра |
Возвращаемое значение
| Type | Description |
| SigmaUser.Builder | Builder для объекта SigmaUser |
SigmaUser.Builder.build
func build() -> SigmaUser
Возвращает собранный с помощью Builder объект SigmaUser.
Возвращаемое значение
| Type | Description |
| SigmaUser | Собранный объект SigmaUser с установленными параметрами userId, profileId, email, custom. |
Использование
import SigmaSDK
let user = SigmaUser.Builder()
.setUserId("123")
.setProfileId("abcd")
.setCustomProperty(true, key: "isAuthorized")
.setEmail("user123@expf.ru")
.build()
Дополнительная информация
При установке кастомного параметра, такой параметр будет сохранен под ключом с префиксом "custom.", например, "custom.isAuthorized".