Перейти к основному содержимому

sigma.editUserProperties()

Позволяет легко изменять или удалять любое свойство userData, экземпляра класса Sigma. Этот метод содержит цепочку вызовов, в которой необходимо вызывать следующий метод для выполнения операций над свойствами userData.

Пример

const token = <TOKEN>;
const userData = {
userId: 'userId',
profileId: 'profileId',
deviceId: 'deviceId',
email: 'example@mail.ru',
custom: {
new_user: true,
level: 2
}
appVersion: 'appVersion',
}

const sigma = new Sigma(token, userData);

sigma.editUserProperties()
.setUserId(userId: 'string')
.setDeviceId(deviceId: 'string')
.setProfileId(profileId: 'string')
.setEmail(email: 'string')
.setAppVersion(appVersion:'string')
.setBrowserName(browserName:'string')
.setBrowserVersion(browserVersion: 'string')
.setOsName(osName: 'string')
.setOsVersion(osVersion: 'string')
.setGeoCountry(country: 'string')
.setGeoCode(code: 'string')
.setGeoState(state: 'string')
.setGeoCity(city: 'string')
.setGeoIp(ip: 'string')
.setCustomProperty(key: 'string', value: 'string | number | boolean')
.removeUserId()
.removeDeviceId()
.removeProfileId()
.removeEmail()
.removeAppVersion()
.removeBrowserName()
.removeBrowserVersion()
.removeOsName()
.removeOsVersion()
.removeGeoCountry()
.removeGeoCode()
.removeGeoState()
.removeGeoCity()
.removeGeoIp()
.removeCustomProperty(key: 'string')

Методы sigma.editUserProperties()

setUserId

sigma.editUserProperties().setUserId(userId: 'string')

Метод изменит или назначит свойство пользователя с названием 'userId'


setDeviceId

sigma.editUserProperties().setDeviceId(deviceId: 'string')

Метод изменит или назначит свойство пользователя с названием 'deviceId'


setProfileId

sigma.editUserProperties().setProfileId(profileId: 'string')

Метод изменит или назначит свойство пользователя с названием 'profileId'


setEmail

sigma.editUserProperties().setEmail(email: 'string')

Метод изменит или назначит свойство пользователя с названием 'email'


setAppVersion

sigma.editUserProperties().setAppVersion(appVersion:'string')

Метод изменит или назначит свойство пользователя с названием 'appVersion'


setBrowserName

sigma.editUserProperties().setBrowserName(browserName:'string') 

Метод изменит или назначит свойство пользователя с названием 'browser.name'


setBrowserVersion

sigma.editUserProperties().setBrowserVersion(browserVersion: 'string')

Метод изменит или назначит свойство пользователя с названием 'browser.version'


setOsName

sigma.editUserProperties().setOsName(osName: 'string')

Метод изменит или назначит свойство пользователя с названием 'os.name'


setOsVersion

sigma.editUserProperties().setOsVersion(osVersion: 'string')

Метод изменит или назначит свойство пользователя с названием 'os.version'


setGeoCountry

sigma.editUserProperties().setGeoCountry(country: 'string')

Метод изменит или назначит свойство пользователя с названием 'geo.country'


setGeoCode

sigma.editUserProperties().setGeoCode(code: 'string') 

Метод изменит или назначит свойство пользователя с названием 'geo.code'


setGeoState

sigma.editUserProperties().setGeoState(state: 'string') 

Метод изменит или назначит свойство пользователя с названием 'geo.state'


setGeoCity

sigma.editUserProperties().setGeoCity(city: 'string')

Метод изменит или назначит свойство пользователя с названием 'geo.city'


setGeoIp

sigma.editUserProperties().setGeoIp(ip: 'string')

Метод изменит или назначит свойство пользователя с названием 'geo.ip'


setCustomProperty

sigma.editUserProperties().setCustomProperty(key: 'string', value: 'string | number | boolean')

Метод изменит или назначит свойство пользователя с названием custom: { key: value }


removeUserId

sigma.editUserProperties().removeUserId()

Метод удалит свойство пользователя с названием 'userId', устанавливая его значение равным null.


removeUserId

sigma.editUserProperties().removeUserId()

Метод удалит свойство пользователя с названием 'userId', устанавливая его значение равным null.


removeDeviceId

sigma.editUserProperties().removeDeviceId()

Метод удалит свойство пользователя с названием 'deviceId', устанавливая его значение равным null.


removeProfileId

sigma.editUserProperties().removeProfileId()

Метод удалит свойство пользователя с названием 'profileId', устанавливая его значение равным null.


removeEmail

sigma.editUserProperties().removeEmail()

Метод удалит свойство пользователя с названием 'email', устанавливая его значение равным null.


removeAppVersion

sigma.editUserProperties().removeAppVersion()

Метод удалит свойство пользователя с названием 'appVersion', устанавливая его значение равным null.


removeBrowserName

sigma.editUserProperties().removeBrowserName()

Метод удалит свойство пользователя с названием 'browser.name', устанавливая его значение равным null.


removeBrowserVersion

sigma.editUserProperties().removeBrowserVersion()

Метод удалит свойство пользователя с названием 'browser.version', устанавливая его значение равным null.


removeOsName

sigma.editUserProperties().removeOsName()

Метод удалит свойство пользователя с названием 'os.name', устанавливая его значение равным null.


removeOsVersion

sigma.editUserProperties().removeOsVersion()

Метод удалит свойство пользователя с названием 'os.version', устанавливая его значение равным null.


removeGeoCountry

sigma.editUserProperties().removeGeoCountry()

Метод удалит свойство пользователя с названием 'geo.country', устанавливая его значение равным null.


removeGeoCode

sigma.editUserProperties().removeGeoCode()

Метод удалит свойство пользователя с названием 'geo.code', устанавливая его значение равным null.


removeGeoState

sigma.editUserProperties().removeGeoState()

Метод удалит свойство пользователя с названием 'geo.state', устанавливая его значение равным null.


removeGeoCity

sigma.editUserProperties().removeGeoCity()

Метод удалит свойство пользователя с названием 'geo.city', устанавливая его значение равным null.


removeGeoIp

sigma.editUserProperties().removeGeoIp()

Метод удалит свойство пользователя с названием 'geo.ip', устанавливая его значение равным null.


removeCustomProperty

sigma.editUserProperties().removeCustomProperty(key: 'string')

Метод удалит из свойства пользователя custom поле по ключу 'key'.