Client
ClientIdentityProvider
Declared In
SNRClientIdentityProvider.h
Declaration
enum ClientIdentityProvider: Int {
synerise,
oauth,
facebook,
apple,
google
}
Functions
Converts from ClientIdentityProvider
to String
.
func SNR_ClientIdentityProviderToString(_: ClientIdentityProvider) -> String
Converts from String
to ClientIdentityProvider
.
func SNR_StringToClientIdentityProvider(_: String) -> ClientIdentityProvider
ClientConditionalAuthenticationContext
Declared In
SNRClientConditionalAuthContext.h
Related To
Inherits From
Declaration
class ClientConditionalAuthContext: BaseModel
Properties
Property | Type | Optional | Default | Description |
---|---|---|---|---|
agreements | ClientAgreements |
yes | nil | Object that stores all agreements of a customer |
attributes | [AnyHashable: Any] |
yes | [] | Additional custom attributes of a customer |
Initializers
init()
ClientAuthenticationContext
Declared In
SNRClientAuthenticationContext.h
Related To
Inherits From
Declaration
class ClientAuthenticationContext: BaseModel
Properties
Property | Type | Optional | Default | Description |
---|---|---|---|---|
agreements | ClientAgreements |
yes | nil | Object that stores all agreements of a customer |
attributes | [AnyHashable: Any] |
yes | [] | Additional custom attributes of a customer |
Initializers
init()
ClientOAuthAuthenticationContext
Declared In
SNRClientOAuthAuthenticationContext.h
Related To
Inherits From
Declaration
class ClientOAuthAuthenticationContext: BaseModel
Properties
Property | Type | Optional | Default | Description |
---|---|---|---|---|
agreements | ClientAgreements |
yes | nil | Object that stores all agreements of a customer |
attributes | [AnyHashable: Any] |
yes | [] | Additional custom attributes of a customer |
Initializers
init()
ClientFacebookAuthenticationContext
Declared In
SNRClientOAuthAuthenticationContext.h
Related To
Inherits From
Declaration
class ClientOAuthAuthenticationContext: BaseModel
Properties
Property | Type | Optional | Default | Description |
---|---|---|---|---|
agreements | ClientAgreements |
yes | nil | Object that stores all agreements of a customer |
attributes | [AnyHashable: Any] |
yes | [] | Additional custom attributes of a customer |
Initializers
init()
ClientAppleSignInAuthenticationContext
Declared In
SNRClientAppleSignInAuthenticationContext.h
Related To
Inherits From
Declaration
class ClientAppleSignInAuthenticationContext: BaseModel
Properties
Property | Type | Optional | Default | Description |
---|---|---|---|---|
agreements | ClientAgreements |
yes | nil | Object that stores all agreements of a customer |
attributes | [AnyHashable: Any] |
yes | [] | Additional custom attributes of a customer |
Initializers
init()
ClientConditionalAuthResult
Declared In
SNRClientConditionalAuthResult.h
Inherits From
Declaration
class ClientConditionalAuthResult: BaseModel
Properties
Property | Type | Optional | Description |
---|---|---|---|
isSuccess | Bool |
no | Result of authentication operation |
token | String |
yes | Token as a raw string |
status | ClientConditionalAuthStatus |
no | Status of the authentication |
conditions | [AnyObject] |
yes | Authentication conditions |
ClientConditionalAuthStatus
Declared In
SNRClientConditionalAuthStatus.h
Declaration
enum ClientConditionalAuthStatus: Int {
success,
unauthorized,
activationRequired,
registrationRequired,
approvalRequired,
termsAcceptanceRequired,
mfaRequired,
unknown
}
Functions
Converts from ClientConditionalAuthStatus
to String
.
func SNR_ClientConditionalAuthStatusToString(_: ClientConditionalAuthStatus) -> String
Converts from String
to ClientConditionalAuthStatus
.
func SNR_StringToClientConditionalAuthStatus(_: String) -> ClientConditionalAuthStatus
ClientSessionEndReason
Declared In
SNRClientSessionEndReason.h
Declaration
enum ClientSessionEndReason: Int {
userSignOut,
systemSignOut,
sessionExpiration,
securityException,
clientRejected,
userAccountDeleted
}
ClientSignOutMode
Declared In
SNRClientSignOutMode.h
Declaration
enum ClientSignOutMode: Int {
.signOut,
.signOutWithSessionDestroy
}
ClientAccountInformation
Declared In
SNRClientAccountInformation.h
Related To
Inherits From
Conforms To
Declaration
class ClientAccountInformation: BaseModel
Properties
Property | Type | Optional | Description |
---|---|---|---|
clientId | Int |
no | Client’s ID |
String |
no | Client’s email | |
phone | String |
yes | Client’s phone |
customId | String |
yes | Client’s custom ID |
uuid | String |
no | Client’s UUID |
firstName | String |
yes | Client’s first name |
lastName | String |
yes | Client’s last name |
displayName | String |
yes | Client’s display name |
sex | ClientSex |
no | Client’s sex |
company | String |
yes | Client’s company |
address | String |
yes | Client’s address |
city | String |
yes | Client’s city |
province | String |
yes | Client’s province |
zipCode | String |
yes | Client’s ZIP code |
countryCode | String |
yes | Client’s country code |
birthDate | String |
yes | Client’s birthdate |
lastActivityDate | Date |
no | Client’s last activity date |
avatarUrl | String |
yes | Client’s avatar URL |
anonymous | Bool |
no | Client’s anonymous flag |
agreements | ClientAgreements |
no | Client’s agreements |
attributes | [AnyHashable: Any] |
yes | Client’s attributes |
tags | [String] |
yes | Client’s tags |
ClientUpdateAccountContext
Declared In
SNRClientUpdateAccountContext.h
Related To
Inherits From
Conforms To
Declaration
class ClientUpdateAccountContext: BaseModel
Properties
Property | Type | Optional | Description |
---|---|---|---|
String |
yes | Customer’s email | |
phone | String |
yes | Customer’s phone |
customId | String |
yes | Customer’s custom ID |
uuid | String |
yes | Customer’s UUID |
firstName | String |
yes | Customer’s first name |
lastName | String |
yes | Customer’s last name |
displayName | String |
yes | Customer’s display name |
sex | ClientSex |
yes | Customer’s sex |
company | String |
yes | Customer’s company |
address | String |
yes | Customer’s address |
city | String |
yes | Customer’s city |
province | String |
yes | Customer’s province |
zipCode | String |
yes | Customer’s ZIP code |
countryCode | String |
yes | Customer’s country code |
birthDate | String |
yes | Customer’s birthdate |
avatarUrl | String |
yes | Customer’s avatar URL |
agreements | ClientAgreements |
no | Customer’s agreements |
attributes | [AnyHashable: Any] |
yes | Customer’s attributes |
Initializers
init()
ClientRegisterAccountContext
Declared In
SNRClientRegisterAccountContext.h
Related To
Inherits From
Declaration
class ClientRegisterAccountContext: BaseModel
Properties
Property | Type | Optional | Description |
---|---|---|---|
String |
no | Customer’s email | |
password | String |
no | Customer’s password |
firstName | String |
yes | Customer’s first name |
lastName | String |
yes | Customer’s last name |
customId | String |
yes | Customer’s custom ID |
sex | ClientSex |
yes | Customer’s sex |
phone | String |
yes | Customer’s phone |
company | String |
yes | Customer’s company |
address | String |
yes | Customer’s address |
city | String |
yes | Customer’s city |
province | String |
yes | Customer’s province code |
zipCode | String |
yes | Customer’s ZIP code |
countryCode | String |
yes | Customer’s country code |
agreements | ClientAgreements |
yes | Customer’s agreements |
attributes | [AnyHashable: Any] |
yes | Customer’s attributes |
Initializers
init(email: String, password: String)
ClientPasswordResetRequestContext
Declared In
SNRClientPasswordResetRequestContext.h
Inherits From
Declaration
class ClientPasswordResetRequestContext: BaseModel
Properties
Property | Type | Optional | Description |
---|---|---|---|
Bool |
no | Customer’s email |
Initializers
init(email: String)
ClientPasswordResetConfirmationContext
Declared In
SNRClientPasswordResetConfirmationContext.h
Inherits From
Declaration
class ClientPasswordResetConfirmationContext: BaseModel
Properties
Property | Type | Optional | Description |
---|---|---|---|
password | String |
no | Customer’s password |
token | String |
no | Customer’s token |
Initializers
init(password: String, token: String)
ClientSex
Declared In
SNRClientSex.h
Declaration
enum ClientSex: Int {
notSpecified,
male,
female,
other
}
Functions
Converts from ClientSex
to String
.
func SNR_ClientSexToString(_: ClientSex) -> String
Converts from String
to ClientSex
.
func SNR_StringToClientSex(_: String) -> ClientSex
ClientAgreements
Declared In
SNRClientAgreements.h
Inherits From
Conforms To
Declaration
class ClientAgreements: BaseModel
Properties
Property | Type | Optional | Description |
---|---|---|---|
Bool |
no | Email agreement | |
sms | Bool |
no | SMS agreement |
push | Bool |
no | Push Notifications agreement |
bluetooth | Bool |
no | Bluetooth agreement |
rfid | Bool |
no | RFID agreement |
wifi | Bool |
no | WIFI agreement |
Initializers
init()
ClientEventData
Declared In
SNRClientEventData.h
Related To
Inherits From
Declaration
class ClientEventData: BaseModel
Properties
Property | Type | Optional | Description |
---|---|---|---|
time | String |
no | Event’s time |
label | String |
no | Event’s label |
action | String |
no | Event’s action |
client | [AnyHashable: Any] |
no | Event’s client identification |
params | [AnyHashable: Any] |
no | Event’s parameters |
Methods
Gets customer ID.
func getClientID() -> Int
Gets customer UUID.
func getClientUUIDString() -> String?
Gets customer email.
func getClientEmail() -> String?
ClientEventsApiQuery
The object to set parameters easily for fetching client events from API.
Declared In
SNRClientEventsApiQuery.h
Inherits From
Declaration
class ClientEventsApiQuery: NSObject
Properties
Property | Type | Optional | Default | Description |
---|---|---|---|---|
actions | [String] |
no | [] | Specifies event actions for query |
timeFrom | String |
yes | nil | Specifies time from for query |
timeTo | String |
yes | nil | Specifies time to for query |
limit | String |
no | 100 | Limit of items in the response |
Initializers
init()
Token
Declared In
SNRToken.h
Related To
Inherits From
[BaseModel
]
Declaration
class Token: BaseModel
Properties
Property | Type | Optional | Description |
---|---|---|---|
tokenString | String |
no | Token as a raw string |
tokenOrigin | TokenOrigin |
no | Token’s origin |
expirationDate | String |
yes | Token’s expiration time |
claimsDictionary | String |
yes | Token’s claims data |
Methods
Checks if the token is near expiration.
func isNearExpiring() -> Bool
TokenOrigin
Declared In
SNRTokenOrigin.h
Declaration
enum TokenOrigin: Int {
unknown,
synerise,
facebook,
oauth,
apple
}
Functions
Converts from TokenOrigin
to String
.
func SNR_TokenOriginToString(_: TokenOrigin) -> String
Converts from String
to TokenOrigin
.
func SNR_StringToTokenOrigin(_: String) -> TokenOrigin