### Synerise **Declared In:** Headers/SNRSynerise.h **Inherits From:** [NSObject](https://developer.apple.com/documentation/objectivec/nsobject) **Declaration:**
```Swift class Synerise: NSObject ```
```Objective-C @interface SNRSynerise : NSObject ```
**Properties:** | Property | Type | Description | | --- | --- | --- | | **settings** | [Settings](/developers/mobile-sdk/class-reference/ios/lifecycle#settings) | Settings module to configure the SDK |
The `settings` property is statically accessible.
**Methods:** This method sets an object for Synerise delegate methods.
```Swift static func setDelegate(_: SyneriseDelegate) ```
```Objective-C + (void)setDelegate:(nonnull id)delegate ```
[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#synerise-delegate) --- This method sets an object for notification delegate methods.
```Swift static func setNotificationDelegate(_: NotificationDelegate) ```
```Objective-C + (void)setNotificationDelegate:(id)delegate ```
[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#notification-delegate) --- This method initializes Synerise.
```Swift static func initialize(apiKey:) ```
```Objective-C + (void)initializeWithApiKey:(nonnull NSString *)apiKey ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#initialization) --- This method initializes Synerise SDK with custom environment settings.
```Swift static func initialize(apiKey:baseUrl:) ```
```Objective-C + (void)initializeWithApiKey:(nonnull NSString *)apiKey andBaseUrl:(nullable NSString *)baseUrl ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#initialize-with-custom-environment) --- This method sets the salt string for request validation.
```Swift static func setRequestValidationSalt(_: String?) ```
```Objective-C + (void)setRequestValidationSalt:(nullable NSString *)string ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#set-request-validation-salt) --- This method changes a Profile (formerly Client) API key dynamically.
```Swift static func changeApiKey(apiKey: String) ```
```Objective-C + (void)changeApiKey:(NSString *)apiKey ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#change-profile-api-key-dynamically) --- This method changes a Profile (formerly Client) API key dynamically, with additional parameters.
```Swift static func changeApiKey(_ apiKey: String, config: InitializationConfig?) -> Void ```
```Objective-C (void)changeApiKey:(NSString *)apiKey config:(nullable SNRInitializationConfig *)config; ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#change-profile-api-key-dynamically-with-config) --- This method sets the Synerise SDK host application type.
```Swift static func setHostApplicationType(_: HostApplicationType) ```
```Objective-C + (void)setHostApplicationType:(SNRHostApplicationType)type ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#set-up-host-application-type) --- This method sets the Synerise SDK plugin version.
```Swift static func setHostApplicationSDKPluginVersion(_: String) ```
```Objective-C + (void)setHostApplicationSDKPluginVersion:(NSString *)type ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#set-host-application-sdk-plugin-version) --- This method enables or disables console logs from Synerise SDK.
```Swift static func setDebugModeEnabled(_: Bool) ```
```Objective-C + (void)setDebugModeEnabled:(BOOL)enabled ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#enable-debug-mode) --- This method enables or disables crash handling by Synerise SDK.
```Swift static func setCrashHandlingEnabled(_: Bool) ```
```Objective-C + (void)setCrashHandlingEnabled:(BOOL)enabled ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/lifecycle#enable-crash-handling) --- This method sets the notification categories (including Synerise categories) that your app supports.
```Swift static func setNotificationCategories(_: Set) ```
```Objective-C + (void)setNotificationCategories:(NSSet *)notificationCategories ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#set-notification-categories) --- This method sets identifiers for Background Tasks processing.
```Swift static func setBackgroundTaskIdentifiers(_: [String]) ```
```Objective-C + (void)setBackgroundTaskIdentifiers:(NSArray *)identifiers ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#set-notification-categories) --- This method verifies if a notification was sent by Synerise.
```Swift static func isSyneriseNotification(_: [AnyHashable: Any]) -> Bool ```
```Objective-C + (BOOL)isSyneriseNotification:(nonnull NSDictionary *)userInfo ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-from-synerise) --- This method verifies if a notification’s sender is Synerise and if the notification is a Simple Push campaign
```Swift static func isSyneriseSimplePush(_: [AnyHashable: Any]) -> Bool ```
```Objective-C + (BOOL)isSyneriseSimplePush:(nonnull NSDictionary *)userInfo ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-a-simple-push-campaign) --- This method verifies if a notification’s sender is Synerise and if the notification is a Banner campaign.
```Swift static func isSyneriseBanner(_: [AnyHashable: Any]) -> Bool ```
```Objective-C + (BOOL)isSyneriseBanner:(nonnull NSDictionary *)userInfo ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-a-banner-campaign) **REMOVED in version 5.0.0** --- This method verifies if a notification's sender is Synerise and if the notification is a Silent Command.
```Swift static func isSyneriseSilentCommand(_: [AnyHashable: Any]) -> Bool ```
```Objective-C + (BOOL)isSyneriseSilentCommand:(nonnull NSDictionary *)userInfo ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-a-silent-command) --- This method verifies if a notification's sender is Synerise and if the notification is a Silent SDK Command.
```Swift static func isSyneriseSilentSDKCommand(_: [AnyHashable: Any]) -> Bool ```
```Objective-C + (BOOL)isSyneriseSilentSDKCommand:(nonnull NSDictionary *)userInfo ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-a-silent-sdk-command) --- This method verifies if a notification is encrypted.
```Swift static func isNotificationEncrypted(_: [AnyHashable: Any]) -> Bool ```
```Objective-C + (BOOL)isNotificationEncrypted:(nonnull NSDictionary *)userInfo ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-push-notification-is-encrypted) --- This method decrypts the notification payload.
```Swift static func decryptNotification(_: [AnyHashable: Any]) -> [AnyHashable: Any]? ```
```Objective-C + (nullable NSDictionary *)decryptNotification:(nonnull NSDictionary *)userInfo ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#decrypt-push-notification) --- This method handles a notification payload and starts activity.
```Swift static func handleNotification(_: [AnyHashable: Any]) ```
```Objective-C + (void)handleNotification:(nonnull NSDictionary *)userInfo ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#handle-synerise-push-notification) --- This method handles a notification payload with a user interaction and starts activity.
```Swift static func handleNotification(_: [AnyHashable: Any], actionIdentifier: String) ```
```Objective-C + (void)handleNotification:(nonnull NSDictionary *)userInfo actionIdentifier:(nullable NSString *)actionIdentifier ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#handle-synerise-push-notification-with-action) ---
- Synerise Domain is declared as a global string constant - `SNRSyneriseDomain` - Synerise Bundle Identifier is declared as a global string constant - `SNRSyneriseBundleIdentifier`
--- --- ### Client The module for managing customer account data, registration, authentication, and authorization. **Declared In:** Headers/SNRClient.h **Related To:** [ClientStateDelegate](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#client-state-delegate) [ClientRegisterAccountContext](/developers/mobile-sdk/class-reference/ios/client#clientregisteraccountcontext) [ClientConditionalAuthResult](/developers/mobile-sdk/class-reference/ios/client#clientconditionalauthresult) [ClientConditionalAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientconditionalauthenticationcontext) [ClientAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientauthenticationcontext) [ClientOAuthAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientoauthauthenticationcontext) [ClientFacebookAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientfacebookauthenticationcontext) [ClientAppleSignInAuthenticationContext](/developers/mobile-sdk/class-reference/ios/client#clientapplesigninauthenticationcontext) [ClientAccountInformation](/developers/mobile-sdk/class-reference/ios/client#clientaccountinformation) [ClientUpdateAccountContext](/developers/mobile-sdk/class-reference/ios/client#clientupdateaccountcontext) [ClientUpdateAccountBasicInformationContext](/developers/mobile-sdk/class-reference/ios/client#clientupdateaccountbasicinformationcontext) [ClientPasswordResetRequestContext](/developers/mobile-sdk/class-reference/ios/client#clientpasswordresetrequestcontext) [ClientPasswordResetConfirmationContext](/developers/mobile-sdk/class-reference/ios/client#clientpasswordresetconfirmationcontext) [Token](/developers/mobile-sdk/class-reference/ios/client#token) **Inherits From:** [NSObject](https://developer.apple.com/documentation/objectivec/nsobject) **Declaration:**
```Swift class Client: NSObject ```
```Objective-C @interface SNRTracker : NSObject ```
**Methods:** This method sets an object for a customers's state delegate methods.
```Swift static func setClientStateDelegate(_: ClientStateDelegate) ```
```Objective-C + (void)setClientStateDelegate:(nonnull id)delegate ```
[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#client-state-delegate) --- This method registers a new customer with an email, password, and optional data.
```Swift static func registerAccount(context: ClientRegisterAccountContext, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)registerAccount:(nonnull SNRClientRegisterAccountContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#register-customer-account) --- This method confirms a customer account with the confirmation token.
```Swift static func confirmAccountActivation(token: String, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)confirmAccount:(nonnull NSString *)token success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#confirm-customer-account-activation) --- This method activates a customer with email.
```Swift static func requestAccountActivation(email: String, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)requestAccountActivation:(nonnull NSString *)email success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#request-customer-account-activation) --- This method requests a customer's account registration process with the PIN code.
```Swift static func requestAccountActivationByPin(email: String, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void ```
```Objective-C + (void)requestAccountActivationByPinWithEmail:(nonnull NSString *)email success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#request-customer-account-activation-by-pin) --- This method confirms a customer's account registration process with the PIN code.
```Swift static func confirmAccountActivationByPin(pinCode: String, email: String, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void ```
```Objective-C + (void)confirmAccountActivationByPin:(nonnull NSString *)pinCode email:(nonnull NSString *)email success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#confirm-customer-account-activation-by-pin) --- This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.
```Swift static func signIn(email: String, password: String, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)signInWithEmail:(nonnull NSString *)email password:(nonnull NSString *)password success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-in-a-customer) --- This method signs a customer in to obtain a JSON Web Token (JWT) which can be used in subsequent requests.
```Swift static func signInConditionally(email: String, password: String, success: ((ClientAuthenticationResult) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)signInConditionallyWithEmail:(nonnull NSString *)email password:(nonnull NSString *)password success:(nonnull void (^)(SNRClientAuthenticationResult *authResult))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-in-a-customer-conditionally) --- This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.
```Swift static func authenticate(token: AnyObject, clientIdentityProvider: ClientIdentityProvider, authID: String?, context: ClientAuthenticationContext?, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) ```
```Objective-C + (void)authenticateWithToken:(id)token clientIdentityProvider:(SNRClientIdentityProvider)clientIdentityProvider authID:(nullable NSString *)authID context:(nullable SNRClientAuthenticationContext *)context success:(void (^)(BOOL isSuccess))success failure:(void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-identityprovider) --- This method authenticates a customer with OAuth, Facebook, Google, Apple, or Synerise.
```Swift static func authenticateConditionally(token: AnyObject, clientIdentityProvider: ClientIdentityProvider, authID: String?, context: ClientConditionalAuthenticationContext?, success: ((ClientAuthenticationResult) -> Void), failure: ((ApiError) -> Void)) ```
```Objective-C + (void)authenticateConditionallyWithToken:(id)token clientIdentityProvider:(SNRClientIdentityProvider)clientIdentityProvider authID:(nullable NSString *)authID context:(nullable SNRClientConditionalAuthenticationContext *)context success:(void (^)(SNRClientAuthenticationResult *authResult))success failure:(void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-conditionally-by-identityprovider) --- This method authenticates a customer with OAuth.
```Swift static func authenticateByOAuth(accessToken: String, authID: String?, context: ClientOAuthAuthenticationContext?, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)authenticateByOAuthWithAccessToken:(nonnull NSString *)accessToken authID:(nullable NSString *)authID context:(nullable SNRClientOAuthAuthenticationContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-oauth-with-registration) - **REMOVED in version 5.0.0** --- This method authenticates a customer with OAuth.
```Swift static func authenticateByOAuthIfRegistered(accessToken: String, authID: String?, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)authenticateByOAuthIfRegisteredWithAccessToken:(nonnull NSString *)accessToken authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-oauth-without-registration) - **REMOVED in version 5.0.0** --- This method authenticates a customer with Facebook.
```Swift static func authenticateByFacebook(facebookToken: String, authID: String?, context: ClientFacebookAuthenticationContext?, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)authenticateByFacebookWithFacebookToken:(nonnull NSString *)facebookToken authID:(nullable NSString *)authID context:(nullable SNRClientFacebookAuthenticationContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-facebook-with-registration) - **REMOVED in version 5.0.0** --- This method authenticates a customer with Facebook.
```Swift static func authenticateByFacebookIfRegistered(facebookToken: String, authID: String?, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)authenticateByFacebookIfRegisteredWithFacebookToken:(nonnull NSString *)facebookToken authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-facebook-without-registration) - **REMOVED in version 5.0.0** --- This method authenticates a customer with Sign In With Apple.
```Swift static func authenticateByAppleSignIn(identityToken: Data, authID: String?, context: ClientAppleSignInAuthenticationContext?, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)authenticateByAppleSignInWithIdentityToken:(nonnull NSData *)identityToken authID:(nullable NSString *)authID context:(nullable SNRClientAppleSignInAuthenticationContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-sign-in-with-apple-with-registration) - **REMOVED in version 5.0.0** --- This method authenticates a customer with Sign In With Apple.
```Swift static func authenticateByAppleSignInIfRegistered(identityToken: Data, authID: String?, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)authenticateByAppleSignInIfRegisteredWithIdentityToken:(nonnull NSData *)identityToken authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-by-sign-in-with-apple-without-registration) - **REMOVED in version 5.0.0** --- This method signs in a customer in with the provided token payload.
```Swift static func authenticate(tokenPayload: TokenPayload, authID: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void ```
```Objective-C + (void)authenticateWithTokenPayload:(SNRTokenPayload *)tokenPayload authID:(NSString *)authID success:(void (^)(void))success failure:(void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-with-token-payload) --- This method authenticates a customer with Simple Profile Authentication.
```Swift static func simpleAuthentication(data: ClientSimpleAuthenticationData, authID: String, success: (() -> Void), failure: ((ApiError) -> Void)) -> Void ```
```Objective-C + (void)simpleAuthentication:(SNRClientSimpleAuthenticationData *)data authID:(NSString *)authID success:(void (^)(void))success failure:(void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#authenticate-customer-via-simple-profile-authentication) --- This method checks if a customer is signed in (via Synerise Authentication - RaaS, OAuth, Facebook, Apple).
```Swift static func isSignedIn() -> Bool ```
```Objective-C + (BOOL)isSignedIn ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#check-if-a-customer-is-signed-in-via-raas-oauth-facebook-apple) --- This method checks if a customer is signed in (via Simple Profile Authentication).
```Swift static func isSignedInViaSimpleAuthentication() -> Bool ```
```Objective-C + (BOOL)isSignedInViaSimpleAuthentication ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#check-if-a-customer-is-signed-in-via-simple-profile-authentication) --- This method signs out a customer out.
```Swift static func signOut() ```
```Objective-C + (void)signOut ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer) --- This method signs out a customer out with a chosen mode.
```Swift static func signOut(mode: ClientSignOutMode) ```
```Objective-C + (void)signOutWithMode:(SNRClientSignOutMode)mode ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer-with-mode) - **REMOVED in version 5.0.0** --- This method signs out a customer out with a chosen mode and Determines if the method should sign out all devices
```Swift static func signOut(mode: ClientSignOutMode, fromAllDevices: Bool, success: (() -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)signOutWithMode:(SNRClientSignOutMode)mode fromAllDevices:(BOOL)fromAllDevices success:(void (^)(void))success failure:(void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-authentication#sign-out-customer-with-mode-or-from-all-devices) --- This method refreshes the customer’s current token.
```Swift static func refreshToken(success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)refreshTokenWithSuccess:(nonnull void (^)(void))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#refresh-customer-token) --- This method retrieves the customer’s current, active token.
```Swift static func retrieveToken(success: ((Token) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)retrieveTokenWithSuccess:(nonnull void (^)(SNRToken *token))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#retrieve-customer-token) --- This method retrieves the customer’s current UUID.
```Swift static func getUUID() -> String ```
```Objective-C + (NSString *)getUUID ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#get-current-customer-uuid) --- Retrieves the current UUID or generates a new one from a seed.
```Swift static func getUUIDForAuthentication(authID: String) -> String ```
```Objective-C + (NSString *)getUUIDForAuthenticationWithAuthID:(NSString *)authID; ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#get-customer-uuid-for-use-in-authentication) --- This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.
```Swift static func regenerateUUID() ```
```Objective-C + (BOOL)regenerateUUID ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#regenerate-customer) --- This method regenerates the UUID and clears the authentication token, login session, custom email, and custom identifier.
```Swift static func regenerateUUID(clientIdentifier: String) ```
```Objective-C + (BOOL)regenerateUUIDWithClientIdentifier:(nullable NSString *)clientIdentifier ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#regenerate-customer-with-identifier) --- This method destroys the session completely.
```Swift static func destroySession() ```
```Objective-C + (void)destroySession ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-session#destroy-current-session) --- This method gets a customer’s account information.
```Swift static func getAccount(success: ((ClientAccountInformation) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getAccountWithSuccess:(void (^)(SNRClientAccountInformation *accountInformation))success failure:(void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#get-customer-account-information) --- This method retrieves events for an authenticated customer.
```Swift static func getEvents(apiQuery: ClientEventsApiQuery, success: (([ClientEventData]) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getEventsWithApiQuery:(nonnull SNRClientEventsApiQuery *)apiQuery success:(nonnull void (^)(NSArray *events))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#get-customers-events) --- This method updates a customer’s account’s basic information (without identification data: uuid, customId, email).
```Swift static func updateAccountBasicInformation(context: ClientUpdateAccountBasicInformationContext, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)updateAccountBasicInformation:(nonnull SNRClientUpdateAccountBasicInformationContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#update-customer-account-basic-information) --- This method updates a customer’s account information.
```Swift static func updateAccount(context: ClientUpdateAccountContext, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)updateAccount:(nonnull SNRClientUpdateAccountContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#update-customer-account-information) --- This method requests a customer’s password reset with email.
```Swift static func requestPasswordReset(context: ClientPasswordResetRequestContext, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)requestPasswordReset:(nonnull SNRClientPasswordResetRequestContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#request-password-reset-for-customer-account) --- This method confirm a customer’s password reset with the new password and token provided by password reset request.
```Swift static func confirmResetPassword(context: ClientPasswordResetConfirmationContext, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)confirmResetPassword:(nonnull SNRClientPasswordResetConfirmationContext *)context success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#confirm-password-reset-for-customer-account) --- This method changes a customer’s password.
```Swift static func changePassword(password: String, oldPassword: String, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)changePassword:(nonnull NSString *)password oldPassword:(nonnull NSString *)oldPassword success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#change-customers-account-password) --- This method requests a customer's email change.
```Swift static func requestEmailChange(email: String, password: String?, externalToken: AnyObject?, authID: String?, success: ((Bool) -> Void), failure: ((ApiError) -> Void)) ```
```Objective-C + (void)requestEmailChange:(NSString *)email password:(nullable NSString *)password externalToken:(nullable id)externalToken authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#request-email-change-for-customer-account) --- This method confirms an email change.
```Swift static func confirmEmailChange(token: String, newsletterAgreement: Bool, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)confirmEmailChange:(nonnull NSString *)token newsletterAgreement:(BOOL)newsletterAgreement success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#confirm-email-change-for-customer-account) --- Requests a customer's phone update. A confirmation code is sent to the phone number.
```Swift static func requestPhoneUpdate(phone: String, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)requestPhoneUpdate:(nonnull NSString *)phone success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#request-phone-update-on-customer-account) --- This method confirms a phone number update. This action requires the new phone number and confirmation code as parameters.
```Swift static func confirmPhoneUpdate(phone:confirmationCode: String, smsAgreement: Bool, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)confirmPhoneUpdate:(nonnull NSString *)phone confirmationCode:(nonnull NSString *)confirmationCode smsAgreement:(BOOL)smsAgreement success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#confirm-phone-update-on-customer-account) --- This method deletes a customer's account.
```Swift static func deleteAccount(clientAuthFactor: AnyObject, clientIdentityProvider: ClientIdentityProvider, authID: String, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)deleteAccount:(nonnull id)clientAuthFactor clientIdentityProvider:(SNRClientIdentityProvider)clientIdentityProvider authID:(nullable NSString *)authID success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#delete-customer-account-by-identity-provider) --- This method deletes a customer's account.
```Swift static func deleteAccount(password: String, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)deleteAccount:(nonnull NSString *)password success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/client-account#delete-customer-account) - **DEPRECATED in version 3.6.19** --- This method passes the Firebase Token to Synerise for notifications and doesn't update the agreement of the profile.
```Swift static func registerForPush(registrationToken: String, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)registerForPush:(nonnull NSString *)registrationToken success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#register-for-push-notifications-without-agreement) --- This method passes the Firebase Token to Synerise for notifications.
```Swift static func registerForPush(registrationToken: String, mobilePushAgreement: Bool, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)registerForPush:(nonnull NSString *)registrationToken mobilePushAgreement:(BOOL)mobilePushAgreement success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#register-for-push-notifications) --- --- ### Tracker The module for sending event tracking data to Synerise backend. Tracking is performed by creating pre-defined or custom event objects and sending these to Synerise. It also includes automatic event interception by the Auto-Tracking feature. **Declared In:** Headers/SNRTracker.h **Related To:** [Event](/developers/mobile-sdk/class-reference/ios/events#event) [TrackerParams](/developers/mobile-sdk/class-reference/ios/events#trackerparams) [TrackerParamsBuilder](/developers/mobile-sdk/class-reference/ios/events#trackerparamsbuilder) **Inherits From:** [NSObject](https://developer.apple.com/documentation/objectivec/nsobject) **Declaration:**
```Swift class Tracker: NSObject ```
```Objective-C @interface SNRTracker : NSObject ```
**Methods:** This method sets an object for Tracker module delegate methods.
```Swift static func setDelegate(_: TrackerDelegate) ```
```Objective-C + (void)setDelegate:(nonnull id)delegate ```
[Click for more details](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#tracker-delegate) --- This method sets a custom identifier in the parameters of every event.
```Swift static func setCustomIdentifier(_: String?) ```
```Objective-C + (void)setCustomIdentifier:(nullable NSString *)customIdentifier ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/tracking#set-custom-identifier-for-events) --- This method sets a custom email in the parameters of every event.
```Swift static func setCustomEmail(_: String?) ```
```Objective-C + (void)setCustomEmail:(nullable NSString *)customEmail ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/tracking#set-custom-email-for-events) --- This method sends an event.
```Swift static func send(_: Event) ```
```Objective-C + (void)send:(SNREvent *)event ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/tracking#send-event) --- This method forces sending the events from the queue to the server.
```Swift static func flushEvents(completionHandler: (() -> Void)?) ```
```Objective-C + (void)flushEventsWithCompletionHandler:(nullable void (^)(void))completion ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/tracking#flush-events-from-tracker) --- --- ### Injector The module for handling Synerise UI activities such as walkthrough, banner, simple push, and so on. **Declared In:** Headers/SNRInjector.h **Inherits From:** [NSObject](https://developer.apple.com/documentation/objectivec/nsobject) **Declaration:**
```Swift class Injector: NSObject ```
```Objective-C @interface SNRInjector : NSObject ```
**Properties:** | Property | Type | Optional | Description | |---|---|---|---| | inAppContext | [String: Any] | No | The global context used for personalizing in-app message content. This property is shared between overlay and inline in-app messages | **Methods:** This method sets an object for in-app messages delegate methods.
```Swift static func setInAppMessageDelegate(_: InjectorInAppMessageDelegate) ```
```Objective-C + (void)setInAppMessageDelegate:(id)delegate ```
[(Click for more details)](/developers/mobile-sdk/listeners-and-delegates/ios-delegates#injector-in-app-message-delegate) --- Closes an in-app message and sends an `inApp.discard` event. Usage examples: - Closing a top bar or bottom bar when the user taps outside the in-app area. - Automatically dismissing messages when navigating away from a screen. - Controlling in-app visibility based on app logic for a smoother user experience.
```swift static func closeInAppMessage(campaignHash: String) -> Void ```
```objective-c + (void)closeInAppMessage:(nonnull NSString *)campaignHash ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#close-in-app-message) --- This method fetches a walkthrough.
```Swift static func getWalkthrough() ```
```Objective-C + (void)getWalkthrough ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#get-walkthrough) - **REMOVED in version 5.0.0** --- This method shows a walkthrough when it is loaded.
```Swift static func showWalkthrough() ```
```Objective-C + (void)showWalkthrough ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#show-walkthrough) - **REMOVED in version 5.0.0** --- This method checks if a walkthrough is loaded.
```Swift static func isWalkthroughLoaded() -> Bool ```
```Objective-C + (BOOL)isWalkthroughLoaded ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-walkthrough-is-loaded) - **REMOVED in version 5.0.0** --- This method checks if the walkthrough is unique compared to the previous one.
```Swift static func isLoadedWalkthroughUnique() -> Bool ```
```Objective-C + (BOOL)isLoadedWalkthroughUnique ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#check-if-loaded-walkthrough-is-unique) - **REMOVED in version 5.0.0** --- This method fetches Push Notifications set for mobile campaigns.
```Swift static func getPushes(success: (([[AnyHashable: Any]]) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getPushesWithSuccess:(nonnull void (^)(NSArray *pushes))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#get-pushes) - **REMOVED in version 5.0.0** --- This method provides valid banners directly from SDK cache.
```Swift static func getBanners() -> [[AnyHashable: Any]] ```
```Objective-C + (nonnull NSArray *)getBanners ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#get-banners) - **REMOVED in version 4.6.0** --- This method fetches banners set for mobile campaigns and caches the valid ones.
```Swift static func fetchBanners(success: (([[AnyHashable: Any]]) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)fetchBannersWithSuccess:(nonnull void (^)(NSArray *banners))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#fetch-banners) - **REMOVED in version 4.6.0** --- This method shows a banner immediately.
```Swift static func showBanner(_: [AnyHashable: Any], markPresented: Bool) ```
```Objective-C + (void)showBanner:(nonnull NSDictionary *)bannerDictionary markPresented:(BOOL)markPresented ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/campaigns#show-banner) - **REMOVED in version 4.6.0** --- --- ### Promotions The module for handling promotions and vouchers from Synerise SDK. **Declared In:** Headers/SNRPromotions.h **Related To:** [PromotionsApiQuery](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionsapiquery) [PromotionIdentifier](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionidentifier) [PromotionResponse](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotionresponse) [Promotion](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#promotion) [AssignVoucherResponse](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#assignvoucherresponse) [VoucherCodesResponse](/developers/mobile-sdk/class-reference/ios/promotions-and-vouchers#vouchercodesresponse) **Inherits From:** [NSObject](https://developer.apple.com/documentation/objectivec/nsobject) **Declaration:**
```Swift class Promotions: NSObject ```
```Objective-C @interface SNRPromotions : NSObject ```
**Methods:** This method retrieves all available promotions that are defined for a customer.
```Swift static func getPromotions(success: ((PromotionResponse) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getPromotionsWithSuccess:(nonnull void (^)(SNRPromotionResponse *promotionResponse))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#get-all-promotions-of-a-customer) --- This method retrieves promotions that match the parameters defined in an API query.
```Swift static func getPromotions(apiQuery: PromotionsApiQuery, success: ((PromotionResponse) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getPromotionsWithApiQuery:(nonnull SNRPromotionsApiQuery *)apiQuery success:(nonnull void (^)(SNRPromotionResponse *promotionResponse))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#get-promotions-with-query-parameters) --- This method retrieves the promotion with the specified UUID.
```Swift static func getPromotion(uuid: String, success: ((Promotion) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getPromotionByUuid:(nonnull NSString *)uuid success:(nonnull void (^)(SNRPromotion *promotion))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#get-promotion-by-uuid) --- This method retrieves the promotion with the specified code.
```Swift static func getPromotion(code: String, success: ((Promotion) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getPromotionByCode:(nonnull NSString *)code success:(nonnull void (^)(SNRPromotion *promotion))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#get-promotion-by-code) --- This method activates the promotion with the specified UUID.
```Swift static func activatePromotion(uuid: String, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)activatePromotionByUuid:(nonnull NSString *)uuid success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#activate-promotion-by-uuid) --- This method activates the promotion with the specified code.
```Swift static func activatePromotion(code: String, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)activatePromotionByCode:(nonnull NSString *)code success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#activate-promotion-by-code) --- This method activates promotions with a code or with UUID in a batch.
```Swift static func activatePromotions(identifiers: [PromotionIdentifier], success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void ```
```Objective-C + (void)activatePromotionsWithIdentifiers:(nonnull NSArray *)identifiers success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#activate-promotions-in-a-batch) --- This method deactivates the promotion with the specified UUID.
```Swift static func deactivatePromotion(uuid: String, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)deactivatePromotionByUuid:(nonnull NSString *)uuid success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#deactivate-promotion-by-uuid) --- This method deactivates the promotion with the specified code.
```Swift static func deactivatePromotion(code: String, success: ((Bool) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)deactivatePromotionByUuid:(nonnull NSString *)uuid success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#deactivate-promotion-by-code) --- This method deactivates promotions with a code or with UUID in a batch.
```Swift static func deactivatePromotions(identifiers: [PromotionIdentifier], success: ((Bool) -> Void), failure: ((ApiError) -> Void)) -> Void ```
```Objective-C + (void)deactivatePromotionsWithIdentifiers:(nonnull NSArray *)identifiers success:(nonnull void (^)(BOOL isSuccess))success failure:(nonnull void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#deactivate-promotions-in-a-batch) --- This method retrieves an assigned voucher code or assigns a voucher from a pool identified by UUID to the profile. When the voucher is assigned for the first time, a [voucherCode.assigned](/docs/assets/events/event-reference/loyalty#vouchercodeassigned) event is produced.
```Swift static func getOrAssignVoucher(poolUUID: String, success: ((AssignVoucherResponse) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getOrAssignVoucherWithPoolUUID:(NSString *)poolUUID success:(void (^)(SNRAssignVoucherResponse *assignVoucherResponse))success failure:(void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#get-or-assign-voucher-from-pool) --- This method assigns a voucher from a pool identified by UUID to the profile. A [voucherCode.assigned](/docs/assets/events/event-reference/loyalty#vouchercodeassigned) event is produced.
```Swift static func assignVoucherCode(poolUUID: String, success: ((AssignVoucherResponse) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)assignVoucherCodeWithPoolUUID:(nonnull NSString *)poolUUID success:(nonnull void (^)(SNRAssignVoucherResponse *assignVoucherResponse))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#assign-voucher-code-from-pool) --- This method retrieves voucher codes for a customer.
```Swift static func getAssignedVoucherCodes(success: ((VoucherCodesResponse) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getAssignedVoucherCodesWithSuccess:(nonnull void (^)(SNRVoucherCodesResponse *voucherCodesResponse))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/promotions#get-voucher-codes-assigned-to-customer) --- --- ### Content The module for handling content from Synerise backend such as documents, recommendations, and so on. **Declared In:** Headers/SNRContent.h **Related To:** [Document](/developers/mobile-sdk/class-reference/ios/recommendations-and-documents#document) [DocumentApiQuery](/developers/mobile-sdk/class-reference/ios/recommendations-and-documents#documentapiquery) [DocumentsApiQuery](/developers/mobile-sdk/class-reference/ios/recommendations-and-documents#documentsapiquery) [RecommendationResponse](/developers/mobile-sdk/class-reference/ios/recommendations-and-documents#recommendationresponse) [Recommendation](/developers/mobile-sdk/class-reference/ios/recommendations-and-documents#recommendation) [ScreenView](/developers/mobile-sdk/class-reference/ios/miscellaneous#screenview) [ScreenViewApiQuery](/developers/mobile-sdk/class-reference/ios/miscellaneous#screenviewapiquery) **Inherits From:** [NSObject](https://developer.apple.com/documentation/objectivec/nsobject) **Declaration:**
```Swift class Content: NSObject ```
```Objective-C @interface SNRContent : NSObject ```
**Methods:** This method generates the document assigned to a slug.
```Swift static func getDocument(slug: String, success: (([AnyHashable: Any]) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getDocument:(nonnull NSString *)slug success:(nonnull void (^)(NSDictionary *document))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#get-document) - **REMOVED in version 5.0.0** --- This method generates the document that is defined for the provided slug.
```Swift static func generateDocument(slug: String, success: ((Document) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)generateDocument:(nonnull NSString *)slug success:(nonnull void (^)(SNRDocument *document))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#generate-document) --- This method generates the document that is defined for parameters provided in the query object.
```Swift static func generateDocument(apiQuery: DocumentApiQuery, success: ((Document) -> Void), failure: ((ApiError) -> Void)) ```
```Objective-C + (void)generateDocumentWithApiQuery:(SNRDocumentApiQuery *)apiQuery success:(void (^)(SNRDocument *document))success failure:(void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#generate-document-with-query-parameters) --- This method generates documents that are defined for parameters provided in the query object.
```Swift static func getDocuments(apiQuery: DocumentsApiQuery, success: (([[AnyHashable: Any]]) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getDocumentsWithApiQuery:(nonnull SNRDocumentsApiQuery *)apiQuery success:(nonnull void (^)(NSArray *documents))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#get-documents) - **REMOVED in version 5.0.0** --- This method generates recommendations that are defined for the options provided. The recommendations are generated by using a document with an insert. For instructions, see ["Displaying AI recommendations > With documents and screen views"](/developers/mobile-sdk/displaying-recommendations/documents).
```Swift static func getRecommendations(options: RecommendationOptions, success: ((RecommendationResponse) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getRecommendations:(nonnull SNRRecommendationOptions *)options success:(nonnull void (^)(SNRRecommendationResponse *recommendationResponse))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#get-recommendations) - **REMOVED in version 5.0.0** --- This method generates recommendations that are defined for the options provided. The recommendations are generated by using a document with an insert. For instructions, see ["Displaying AI recommendations > With documents and screen views"](/developers/mobile-sdk/displaying-recommendations/documents).
```Swift static func getRecommendationsV2(apiQuery: RecommendationApiQuery, success: ((RecommendationResponse) -> Void), failure: ((Error) -> Void)) ```
```Objective-C + (void)getRecommendationsV2:(nonnull SNRRecommendationApiQuery *)apiQuery success:(nonnull void (^)(SNRRecommendationResponse *recommendationResponse))success failure:(nonnull void (^)(NSError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#get-recommendations-v2) --- This method generates the customer's highest-priority screen view campaign.
```Swift static func getScreenView(success: ((ScreenViewResponse) -> Void), failure: ((ApiError) -> Void)) ```
```Objective-C + (void)getScreenViewWithSuccess:(nonnull void (^)(SNRScreenViewResponse *screenViewResponse))success failure:(nonnull void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#get-screen-view) - **REMOVED in version 5.0.0** --- This method generates a customer's highest-priority screen view campaign from the feed with the provided feed slug.
```Swift static func generateScreenView(feedSlug: String, success: ((ScreenView) -> Void), failure: ((ApiError) -> Void)) ```
```Objective-C + (void)generateScreenView:(NSString *)feedSlug success:(nonnull void (^)(SNRScreenView *screenView))success failure:(nonnull void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#generate-screen-view) --- This method generates customer's highest-priority screen view campaign that is defined for parameters provided in the query object.
```Swift static func generateScreenView(apiQuery: ScreenViewApiQuery, success: ((ScreenView) -> Void), failure: ((ApiError) -> Void)) ```
```Objective-C + (void)generateScreenView:(SNRScreenViewApiQuery *)apiQuery success:(nonnull void (^)(SNRScreenView *screenView))success failure:(nonnull void (^)(SNRApiError *error))failure ```
[(Click for more details)](/developers/mobile-sdk/method-reference/ios/content#generate-screen-view-with-query-parameters)