ClientIdentityProvider
Declared In:
Headers/SNRClientIdentityProvider.h
Declaration:
enum ClientIdentityProvider: Int {
synerise,
oauth,
simpleAuth,
facebook,
apple,
google
}
typedef NS_ENUM(NSUInteger, SNRClientIdentityProvider) {
SNRClientIdentityProviderSynerise,
SNRClientIdentityProviderOAuth,
SNRClientIdentityProviderSimpleAuth,
SNRClientIdentityProviderFacebook,
SNRClientIdentityProviderApple,
SNRClientIdentityProviderGoogle
}
Functions:
Converts from ClientIdentityProvider to String.
func SNR_ClientIdentityProviderToString(_: ClientIdentityProvider) -> String
NSString * SNR_ClientIdentityProviderToString(SNRClientIdentityProvider type)
Converts from String to ClientIdentityProvider.
func SNR_StringToClientIdentityProvider(_: String) -> ClientIdentityProvider
SNRClientIdentityProvider SNR_StringToClientIdentityProvider(NSString * _Nullable string)
ClientConditionalAuthenticationContext
Declared In:
Headers/SNRClientConditionalAuthContext.h
Related To:
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientConditionalAuthContext: BaseModel
@interface SNRClientConditionalAuthContext : SNRBaseModel
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()
- (instancetype)init
ClientAuthenticationContext
Declared In:
Headers/SNRClientAuthenticationContext.h
Related To:
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientAuthenticationContext: BaseModel
@interface SNRClientAuthenticationContext : SNRBaseModel
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()
- (instancetype)init
ClientConditionalAuthResult
Declared In:
Headers/SNRClientConditionalAuthResult.h
Inherits From:
BaseModel
Declaration:
class ClientConditionalAuthResult: BaseModel
@interface SNRClientConditionalAuthResult : SNRBaseModel
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 |
All properties are read-only.
ClientConditionalAuthStatus
Declared In:
Headers/SNRClientConditionalAuthStatus.h
Declaration:
enum ClientConditionalAuthStatus: Int {
success,
unauthorized,
activationRequired,
registrationRequired,
approvalRequired,
termsAcceptanceRequired,
mfaRequired,
unknown
}
typedef NS_ENUM(NSUInteger, SNRClientConditionalAuthStatus) {
SNRClientConditionalAuthStatusSuccess,
SNRClientConditionalAuthStatusUnauthorized,
SNRClientConditionalAuthStatusActivationRequired,
SNRClientConditionalAuthStatusRegistrationRequired,
SNRClientConditionalAuthStatusApprovalRequired,
SNRClientConditionalAuthStatusTermsAcceptanceRequired,
SNRClientConditionalAuthStatusMFARequired,
SNRClientConditionalAuthStatusUnknown
}
Functions:
Converts from ClientConditionalAuthStatus to String.
func SNR_ClientConditionalAuthStatusToString(_: ClientConditionalAuthStatus) -> String
NSString * SNR_ClientConditionalAuthStatusToString(SNRClientConditionalAuthStatus status)
Converts from String to ClientConditionalAuthStatus.
func SNR_StringToClientConditionalAuthStatus(_: String) -> ClientConditionalAuthStatus
SNRClientConditionalAuthStatus SNR_StringToClientConditionalAuthStatus(NSString * _Nullable string)
ClientSimpleAuthenticationData
Declared In:
Headers/SNRClientSimpleAuthenticationData.h
Related To:
ClientSex
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientSimpleAuthenticationData: BaseModel
@interface SNRClientSimpleAuthenticationData : SNRBaseModel
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 | yes | Customer's agreements |
| attributes | [AnyHashable: Any] | yes | Customer's attributes |
Initializers:
init()
- (instancetype)init
ClientSessionEndReason
Declared In:
Headers/SNRClientSessionEndReason.h
Declaration:
enum ClientSessionEndReason: Int {
userSignOut,
systemSignOut,
sessionExpiration,
securityException,
clientRejected,
userAccountDeleted
}
typedef NS_ENUM(NSUInteger, SNRClientSessionEndReason) {
SNRClientSessionEndReasonUserSignOut,
SNRClientSessionEndReasonSystemSignOut,
SNRClientSessionEndReasonSessionExpiration,
SNRClientSessionEndReasonSessionDestroyed,
SNRClientSessionEndReasonSecurityException,
SNRClientSessionEndReasonClientRejected,
SNRClientSessionEndReasonUserAccountDeleted
}
ClientSignOutMode
Declared In:
Headers/SNRClientSignOutMode.h
Declaration:
enum ClientSignOutMode: Int {
.signOut,
.signOutWithSessionDestroy
}
typedef NS_ENUM(NSUInteger, SNRClientSignOutMode) {
SNRClientSignOutModeSignOut,
SNRClientSignOutModeSignOutWithSessionDestroy
}
ClientAccountInformation
Declared In:
Headers/SNRClientAccountInformation.h
Related To:
ClientSex
ClientAgreements
Inherits From:
BaseModel
Conforms To:
NSSecureCoding
Declaration:
class ClientAccountInformation: BaseModel
@interface SNRClientAccountInformation : SNRBaseModel
Properties:
| Property | Type | Optional | Description |
|---|---|---|---|
| clientId | Int | no | Customer's ID |
| String | no | Customer's email | |
| phone | String | yes | Customer's phone |
| customId | String | yes | Customer's custom ID |
| uuid | String | no | 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 | no | 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 |
| lastActivityDate | Date | no | Customer's last activity date |
| avatarUrl | String | yes | Customer's avatar URL |
| anonymous | Bool | no | Customer's anonymous flag |
| agreements | ClientAgreements | no | Customer's agreements |
| attributes | [AnyHashable: Any] | yes | Customer's attributes |
| tags | [String] | yes | Customer's tags |
All properties are read-only.
ClientUpdateAccountBasicInformationContext
Declared In:
Headers/SNRClientUpdateAccountBasicInformationContext.h
Related To:
ClientSex
ClientAgreements
Inherits From:
BaseModel
Conforms To:
NSSecureCoding
Declaration:
class ClientUpdateAccountBasicInformationContext: BaseModel
@interface SNRClientUpdateAccountBasicInformationContext : SNRBaseModel
Properties:
| Property | Type | Optional | Description |
|---|---|---|---|
| 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 |
| 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 |
| 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()
- (instancetype)init
ClientUpdateAccountContext
Declared In:
Headers/SNRClientUpdateAccountContext.h
Related To:
ClientSex
ClientAgreements
Inherits From:
BaseModel
Conforms To:
NSSecureCoding
Declaration:
class ClientUpdateAccountContext: BaseModel
@interface SNRClientUpdateAccountContext : SNRBaseModel
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()
- (instancetype)init
ClientRegisterAccountContext
Declared In:
Headers/SNRClientRegisterAccountContext.h
Related To:
ClientSex
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientRegisterAccountContext: BaseModel
@interface SNRClientRegisterAccountContext : SNRBaseModel
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)
- (instancetype)initWithEmail:(nonnull NSString *)email andPassword:(nonnull NSString *)password
ClientPasswordResetRequestContext
Declared In:
Headers/SNRClientPasswordResetRequestContext.h
Inherits From:
BaseModel
Declaration:
class ClientPasswordResetRequestContext: BaseModel
@interface SNRClientPasswordResetRequestContext : SNRBaseModel
Properties:
| Property | Type | Optional | Description |
|---|---|---|---|
| Bool | no | Customer's email |
Initializers:
init(email: String)
- (instancetype)initWithEmail:(nonnull NSString *)email
ClientPasswordResetConfirmationContext
Declared In:
Headers/SNRClientPasswordResetConfirmationContext.h
Inherits From:
BaseModel
Declaration:
class ClientPasswordResetConfirmationContext: BaseModel
@interface SNRClientPasswordResetConfirmationContext : SNRBaseModel
Properties:
| Property | Type | Optional | Description |
|---|---|---|---|
| password | String | no | Customer's password |
| token | String | no | Customer's token |
Initializers:
init(password: String, token: String)
- (instancetype)initWithPassword:(nonnull NSString *)password andToken:(nonnull NSString *)token
ClientSex
Declared In:
Headers/SNRClientSex.h
Declaration:
enum ClientSex: Int {
notSpecified,
male,
female,
other
}
typedef NS_ENUM(NSUInteger, SNRClientSex) {
SNRClientSexNotSpecified = 0,
SNRClientSexMale,
SNRClientSexFemale,
SNRClientSexOther,
}
Functions:
Converts from ClientSex to String.
func SNR_ClientSexToString(_: ClientSex) -> String
NSString * SNR_ClientSexToString(SNRClientSex type)
Converts from String to ClientSex.
func SNR_StringToClientSex(_: String) -> ClientSex
SNRClientSex SNR_StringToClientSex(NSString * _Nullable string)
ClientAgreements
Declared In:
Headers/SNRClientAgreements.h
Inherits From:
BaseModel
Conforms To:
NSSecureCoding
NSCopying
Declaration:
class ClientAgreements: BaseModel
@interface SNRClientAgreements : SNRBaseModel
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()
- (instancetype)init
ClientEventData
Declared In:
Headers/SNRClientEventData.h
Related To:
Event
Inherits From:
BaseModel
Declaration:
class ClientEventData: BaseModel
@interface SNRClientEventData : SNRBaseModel
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 customer identification |
| params | [AnyHashable: Any] | no | Event's parameters |
All properties are read-only.
Methods:
This method retrieves a customer ID.
func getClientID() -> Int
- (NSInteger)getClientID
This method retrieves a customer UUID.
func getClientUUIDString() -> String?
- (nullable NSString *)getClientUUIDString
This method retrieves a customer email.
func getClientEmail() -> String?
- (nullable NSString *)getClientEmail
ClientEventsApiQuery
The object to set parameters easily for fetching client events from API.
Declared In:
Headers/SNRClientEventsApiQuery.h
Inherits From:
NSObject
Declaration:
class ClientEventsApiQuery: NSObject
@interface SNRClientEventsApiQuery : 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()
- (instancetype)init
TokenPayload
Declared In:
Headers/SNRTokenPayload.h
Related To:
TokenOrigin
Inherits From:
BaseModel
Declaration:
class TokenPayload: BaseModel
@interface SNRTokenPayload : SNRBaseModel
Properties:
| Property | Type | Optional | Description |
|---|---|---|---|
| tokenString | String | no | Token as a raw string |
| expirationDate | Date | no | Token's expiration time |
| creationDate | Date | no | Token's creation time |
| rlm | String | no | Token's RLM |
| origin | TokenOrigin | no | Token's origin |
| uuid | String | no | Customer's UUID |
| clientId | String | no | Customer's ID |
| customId | String | yes | Customer's custom ID |
Initializers:
init(tokenString: String, expirationDate: Date, creationDate: Date, rlm: String, origin: TokenOrigin, uuid: String, clientId: String, customId: String?)
- (instancetype)initWithTokenString:(NSString *)tokenString expirationDate:(NSDate *)expirationDate creationDate:(NSDate *)creationDate rlm:(NSString *)rlm origin:(SNRTokenOrigin)origin uuid:(NSString *)uuid clientId:(NSString *)clientId customId:(nullable NSString *)customId;
Token
Declared In:
Headers/SNRToken.h
Related To:
TokenOrigin
Inherits From:
BaseModel
Declaration:
class Token: BaseModel
@interface SNRToken : SNRBaseModel
Properties:
| Property | Type | Optional | Description |
|---|---|---|---|
| tokenString | String | no | Token as a raw string |
| expirationDate | String | no | Token's expiration time |
| rlm | String | no | Token's RLM |
| origin | TokenOrigin | no | Token's origin |
| clientId | String | no | Customer's ID |
| customId | String | yes | Customer's custom ID |
Methods: Checks if the token is near expiration.
func isNearExpiring() -> Bool
- (BOOL)isNearExpiring
TokenOrigin
The Oauth value was renamed in 5.0.0 version to OAuth.
Declared In:
Headers/SNRTokenOrigin.h
Declaration:
enum TokenOrigin: Int {
unknown,
synerise,
simpleAuth,
facebook,
OAuth,
apple
}
typedef NS_ENUM(NSUInteger, SNRTokenOrigin) {
SNRTokenOriginUnknown,
SNRTokenOriginSynerise,
SNRTokenOriginSimpleAuth,
SNRTokenOriginFacebook,
SNRTokenOriginOAuth,
SNRTokenOriginApple
}
Functions: Converts from TokenOrigin to String.
func SNR_TokenOriginToString(_: TokenOrigin) -> String
NSString * SNR_TokenOriginToString(SNRTokenOrigin type)
Converts from String to TokenOrigin.
func SNR_StringToTokenOrigin(_: String) -> TokenOrigin
SNRTokenOrigin SNR_StringToTokenOrigin(NSString *string)
Removed symbols
ClientOAuthAuthenticationContext
| iOS SDK | Android SDK | React Native SDK | Flutter SDK | |
|---|---|---|---|---|
| Introduced in: | 3.6.11 | 3.6.13 | 0.9.12 | n/a |
| Deprecated in: | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| Removed in: | 5.0.0 | 6.0.0 | 1.0.0 | n/a |
| Declared In: | ||||
| Headers/SNRClientOAuthAuthenticationContext.h |
Related To:
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientOAuthAuthenticationContext: BaseModel
@interface SNRClientOAuthAuthenticationContext : SNRBaseModel
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()
- (instancetype)init
ClientFacebookAuthenticationContext
| iOS SDK | Android SDK | React Native SDK | Flutter SDK | |
|---|---|---|---|---|
| Introduced in: | 3.3.8 | 3.3.0 | 0.9.7 | n/a |
| Deprecated in: | 3.7.6 | 3.8.0 | 0.9.19 | n/a |
| Removed in: | 5.0.0 | 6.0.0 | 1.0.0 | n/a |
| Declared In: | ||||
| Headers/SNRClientFacebookAuthenticationContext.h |
Related To:
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientFacebookAuthenticationContext: BaseModel
@interface SNRClientFacebookAuthenticationContext : SNRBaseModel
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()
- (instancetype)init
ClientAppleSignInAuthenticationContext
| iOS SDK | Android SDK | React Native SDK | Flutter SDK | |
|---|---|---|---|---|
| Introduced in: | 3.6.11 | n/a | 0.9.12 | n/a |
| Deprecated in: | 3.7.6 | n/a | 0.9.19 | n/a |
| Removed in: | 5.0.0 | n/a | 1.0.0 | n/a |
| Declared In: | ||||
| Headers/SNRClientAppleSignInAuthenticationContext.h |
Related To:
ClientAgreements
Inherits From:
BaseModel
Declaration:
class ClientAppleSignInAuthenticationContext: BaseModel
@interface SNRClientAppleSignInAuthenticationContext : SNRBaseModel
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()
- (instancetype)init