Overview

This WebexConnectPush module enables your application to receive and handle push notifications. It abstracts the underlying push notification service, providing a customization support for notification management.

WebexConnectAppDelegate

PushMessaging Protocol

FCMPushProvider Protocol

PushTokenDelegate Protocol

PushMessagingDelegate Protocol

PushActionsDelegate Protocol

InAppNotificationDelegate Protocol

InAppNotificationManager Protocol

InAppNotificationViewBinder Protocol

InAppNotificationViewBinderFactory Protocol

InAppBannerNotificationViewBinderFactory

Styles

Enums

PushMessagingProvider

PushMessagingProvider is a class that provides a singleton instance of PushMessaging.

Properties

Sample Code:

let push = PushMessagingProvider.instance

id<PushMessaging> push = [PushMessagingProvider instance];

WebexConnectAppDelegate Class

WebexConnectAppDelegate is a class that conforms to the UIApplicationDelegate protocol.

This class includes various application lifecycle methods related to remote notifications.

Methods

application(_:didFinishLaunchingWithOptions:)

This method is used to initialize the SDK. It reads the configuration from the IMIconnectConfiguration.plist file. If the app is allowed to use push notifications, it will register the app for push notifications.

Syntax: func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [AnyHashable : Any]? = nil) -> Bool

Returns: A Boolean value indicating whether the app launch process was successful.

application(_:didRegisterForRemoteNotificationsWithDeviceToken:)

This method is used to send the device token to the back end in order to be used to send push notification to the user.

Syntax:func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data)

Parameters

application(_:didFailToRegisterForRemoteNotificationsWithError:)

This method is called when the app failed to register with Apple Push Notification service (APNs).

Syntax: func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error)

Parameters

application(_:didReceiveRemoteNotification:fetchCompletionHandler:)

This method is used to handle the received remote notification. Using this method a notification can be sent to the user or to notify the app with changes done on Webex Connect. A delivery report will be sent to the back end.

Syntax: func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void)

Parameters

userNotificationCenter(_:willPresent:withCompletionHandler:)

This method is used to handle the notification received when application is in the foreground.

Syntax: func userNotificationCenter(_ center: UNUserNotificationCenter, willPresent notification: UNNotification, withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void)

Parameters

userNotificationCenter(_:didReceive:withCompletionHandler:)

This method is used to handle the notification response when the user responded to the notification by opening the application, dismissing the notification or choosing a UNNotificationAction.

Syntax: func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void)

Parameters

PushMessage

PushMessage is a structure that represents a push message.

Properties

PushDisplayOptions

A class represents display options of a push message.

Properties

PushInteractiveData

A class represents the Push interactive data.

Properties

Methods

init

Initializes a new instance of PushInteractiveData.

Syntax:public init(identifier: String? = nil, category: String? = nil, action: String? = nil, value: String? = nil)

Parameters:

PushMessaging Protocol

Protocol defining the basic structure for push notification handling.

Properties

Methods

requestNotificationPermission

Requests the user's permission prompt to enable push notifications to display on iOS devices.

Syntax: func requestNotificationPermission()

📘

Note

This method should be called manually only if the shouldRequestNotificationPermission value is set to false in the Configuration plist. If shouldRequestNotificationPermission is true, this method is automatically invoked after user registration.

Sample Code:

let push = PushMessagingProvider.instance 
push.requestNotificationPermission()

id<PushMessaging> push = [PushMessagingProvider instance]; 

[push requestNotificationPermission]; 

processPushToken(token:type:completionHandler)

Processes the push notification token based on the token type.

Syntax: func processPushToken(_ token: String, type: PushTokenType, completionHandler: @escaping (Error?) -> Void)

Parameters

Sample Code:

let push = PushMessagingProvider.instance 
push.processPushToken("apnsToken", type: .apns) { error in 
            if error == nil { 
                print("Token posted successfully") 
            } else { 
                print("Error while processing push token: \(error!.localizedDescription)") 
            } 
        }

id<PushMessaging> push = [PushMessagingProvider instance]; 
[push processPushToken:@"apnstoken" type:PushTokenTypeApns completionHandler:^(NSError * error) { 
        if (error == nil) { 
            NSLog(@"Token posted successfully "); 
        } else { 
NSLog(@"Error while processing push token : %@", error) 
        } 
    }]; 

setAppDelegateMethodSwizzlingEnabled

This method enables/disables method swizzling for application life cycle methods and remote notifications methods based on isEnabled parameter value.

Syntax func setAppDelegateMethodSwizzlingEnabled(_ isEnabled: Bool)

Parameters

Sample Code:

let push = PushMessagingProvider.instance 
push.setAppDelegateMethodSwizzlingEnabled(true)

id<PushMessaging> push = [PushMessagingProvider instance]; 
[push setAppDelegateMethodSwizzlingEnabled:true];

setNotificationCenterMethodSwizzlingEnabled

This method Sets User Notification Center Delegate in Webex Connect SDK based on _isEnabled parameter value. By default this will be set to TRUE and sets the User Notification Center Delegate.

Syntax: func setNotificationCenterMethodSwizzlingEnabled(_isEnabled: Bool)

Parameters

Sample Code:

let push = PushMessagingProvider.instance 
push.setNotificationCenterMethodSwizzlingEnabled (true) 

id<PushMessaging> push = [PushMessagingProvider instance]; 
[push setNotificationCenterMethodSwizzlingEnabled:true];

isConnectPushMessage

Checks if the provided dictionary represents a Connect push message. Returns true if the dictionary represents a Connect push message, false otherwise.

Syntax: func isConnectPushMessage(userInfo: [String: Any]) -> Bool

Parameters

Sample Code:

let push = PushMessagingProvider.instance 
push.isConnectPushMessage (userInfo: ["message" : "test"])

id<PushMessaging> push = [PushMessagingProvider instance]; 
[push isConnectPushMessageWithUserInfo:@{ "message" : "test"}];

sendMessageStatus(forTransIds: status: completionHandler)

This method is used to send the status of one or more messages identified by array of transactionIds. The results of the operation are reported through the completionHandler

Syntax: func sendMessageStatus(forTransIds transIds: [String], status: PushMessageStatus, completionHandler: @escaping (Error?) -> Void)

Parameters

Sample Code:

let push = PushMessagingProvider.instance 
push.sendMessageStatus(forTransIds: ["transId"], status: .delivered) { error in 
 //Handle error 
 } 

id<PushMessaging> push = [PushMessagingProvider instance]; 
[push sendMessageStatusForTransIds:@[@"transId"] status:PushMessageStatusDelivered completionHandler:^(NSError * error) { 
     //Handle error 
}];

sendMessageStatus(forTransId: status: interactiveData: completionHandler)

This method is used to send the status message identified by transactionId. The results of the operation are reported through the completionHandler

Syntax: func sendMessageStatus(forTransId transId: String, status: PushMessageStatus, interactiveData: PushInteractiveData?, completionHandler: @escaping (Error?) -> Void)

Parameters

Sample Code:

let push = PushMessagingProvider.instance 
push.sendMessageStatus(forTransId: "transId", status: .delivered, interactiveData:nil) { error in 

            //Handle error 

        } 

id<PushMessaging> push = [PushMessagingProvider instance]; 
[push sendMessageStatusForTransId:@"transId" status:PushMessageStatusDelivered interactiveData:nil completionHandler:^(NSError * error) { 

        //Handle error 

    }];   

FCMPushProvider Protocol

A protocol that defines the required functionalities for handling FCM (Firebase Cloud Messaging) push notifications.

Methods

getToken()

This method gets the FCM push registration token.

Syntax: func getToken() -> String?

subscribeToTopic(_:completionHandler:)

This method subscribes to a FCM topic. The completionHandler closure handles any errors that occur during the subscription process.

Syntax: func subscribeToTopic(_ topic: String, completionHandler: @escaping (Error?) -> Void)

unsubscribeFromTopic(_:)

This method unsubscribes from a given FCM topic.

Syntax: func unsubscribeFromTopic(_ topic: String)

fetchFcmToken(usingAPNSToken:, completionHandler:)

This method fetches the FCM token using the provided Apple Push Notification Service (APNS) token.

Syntax: func fetchFcmToken(usingAPNSToken data: Data, completionHandler: @escaping (String?, Error?) -> Void)

Parameters

Sample Code:

Create a class that will confirm to FCMPushProvider protocol and implements the FCM related methods as shown below:

import Foundation 
import FirebaseCore 
import FirebaseMessaging 
import WebexConnectPush 
import WebexConnectCore 

class FCMTokenManager: NSObject, MessagingDelegate, FCMPushProvider { 
    var fcmToken: String? 
    override init() { 
        super.init() 
        FirebaseApp.configure() 
        Messaging.messaging().delegate = self 
    } 
    func getToken() -> String? { 
        return self.fcmToken 
    } 
    func fetchFcmToken(usingAPNSToken data: Data, completionHandler: @escaping (String?, Error?) -> Void) { 

		#if DEBUG 
        let apnsTokenType: MessagingAPNSTokenType = .sandbox 
		#else 
        let apnsTokenType: MessagingAPNSTokenType = .unknown 
		#endif 
        Messaging.messaging().setAPNSToken(data, type: apnsTokenType) 
        Messaging.messaging().token { newFcmToken, error in 
            self.fcmToken = newFcmToken 
            completionHandler(newFcmToken, error) 
        } 
    } 
    func subscribeToTopic(_ topic: String, completionHandler: @escaping (Error?) -> Void) { 
        Messaging.messaging().subscribe(toTopic: topic, completion: completionHandler) 
    } 
    func unsubscribeFromTopic(_ topic: String) { 
        Messaging.messaging().unsubscribe(fromTopic: topic) 
    } 
    func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String?) { 
        print("FCM registration token: \(String(describing: fcmToken))") 
        self.fcmToken = fcmToken 
        processFCMPushToken() 
    } 
    func processFCMPushToken() { 
        if let fcmToken, WebexConnectProvider.instance.isRegistered { 
            PushMessagingProvider.instance.processPushToken(fcmToken, type: .fcm, completionHandler: { _ in }) 
        } 
    } 
} 

PushTokenDelegate Protocol

Protocol defining the delegate methods for receiving push token related updates.

Methods

didUpdatePushToken(_:type)

Notifies the delegate when the device token is updated.

Syntax: func didUpdatePushToken(_ pushToken: String, type: PushTokenType)

Parameters

PushMessagingDelegate Protocol

Protocol defining the delegate methods for handling push message reception.

Methods

didReceiveMessage(message:fromTap:)

This method notifies the delegate when a push message is received.

Syntax: func didReceiveMessage(message: PushMessage, fromTap: Bool)

Parameters

PushActionsDelegate Protocol

Protocol defining the delegate methods for handling push message actions.

Methods

handleAction(_:withIdentifier:forMessage:responseInfo:)

Processes the specified action taken by the user on a given push message. This method is responsible for handling interactive actions triggered by the user from a push notification. If the action is successfully handled, it returns true; otherwise, the SDK will continue to process the action.

Syntax: func handleAction(_ action: String, withIdentifier identifier: String, forMessage message: PushMessage, responseInfo: [String: Any]?) -> Bool

Parameters

Return Type: Bool

Returns true if the action was handled successfully; otherwise, false indicating the SDK should handle the action.

InAppNotificationDelegate Protocol

This protocol represents callback methods implemented in InAppNotificationViewBinder to listen for InAppNotification displayed events, action click events, and dismiss events.

Methods

onNotificationDisplayed(message:)

This method will be invoked when InApp Notification is displayed.

Syntax: func onNotificationDisplayed(message: PushMessage?)

Parameters

onNotificationClicked(message: action: value:)

This method will be invoked when InApp Notification action is clicked.

Syntax: func onNotificationClicked(message: PushMessage?, action: String?, value: String?)

Parameters

onNotificationDismissed(message:)

This method will be invoked when InApp Notification is dismissed.

Syntax: func onNotificationDismissed(message: PushMessage?)

Parameters

InAppNotificationManager Protocol

The InAppNotificationManager protocol defines the interface for managing in-app notifications. It extends the NSObject class.

Properties

Methods

registerViewFactory(_:)

Registers a view factory responsible for creating in-app notification views.

Syntax: func registerViewFactory(_ notificationFactory: InAppNotificationViewBinderFactory)

Parameters

displayInAppNotification(_:)

Displays an in-app notification using the provided push message.

Syntax: func displayInAppNotification(_ message: PushMessage)

Parameters

Sample Code:

let notificationManager = PushMessagingProvider.instance.inAppNotificationManager 
notificationManager?.inAppdelegate = self 
notificationManager?.registerViewFactory(InAppNotificationModalViewBinderFactory()) 

id<PushMessaging> push = [PushMessagingProvider instance]; 
id<InAppNotificationManager> inAppNotificationManager = [push inAppNotificationManager]; 
 inAppNotificationManager.inAppdelegate = self; 
 [inAppNotificationManager registerViewFactory:[[InAppNotificationModalViewBinderFactory alloc] init]]; 

InAppNotificationViewBinder Protocol

A protocol for managing the behavior of in-app notification views.

Properties

Methods

bindMessage(_:)

Binds the given push message to the notification view.

Syntax: func bindMessage(_ message: PushMessage)

Parameters

setViewStyle(_:)

Sets the visual style of the notification view.

Syntax: func setViewStyle(_ style: InAppNotificationViewStyle)

Parameters

setTheme(_:)

Sets the theme of the notification view.

Syntax: func setTheme(_ theme: InAppNotificationTheme)

Parameters

getView()

Retrieves the view controller associated with the notification view.

Syntax: func getView() -> UIViewController

Parameters

InAppNotificationViewBinderFactory Protocol

A factory protocol for creating instances of InAppNotificationViewBinder. Conforming types are responsible for handling a specific type of in-app notification.

Properties

Methods

createNotificationView()

Creates a new InAppNotificationViewBinder instance.

Syntax: public func createNotificationView() -> InAppNotificationViewBinder

Parameters

InAppNotificationViewBinderDelegate Protocol

A delegate protocol for handling in-app notification events.

Methods

onNotificationDisplayed(_:)

Invoked whenever an in-app notification is displayed.

Syntax: func onNotificationDisplayed(_ message: PushMessage)

Parameters

onNotificationClicked(_:withAction:value:)

Invoked whenever an in-app notification is clicked.

Syntax: func onNotificationClicked(_ message: PushMessage, withAction action: String, value: String)

Parameters

onNotificationDismiss(_:)

Invoked whenever an in-app notification is dismissed.

Syntax: func onNotificationDismissed(_ message: PushMessage)

Parameters

InAppNotificationModalViewBinderFactory

This class is responsible for creating instances of InAppNotificationViewBinder for modal notifications.

Properties:

Methods

createNotificationView()

Creates a new instance of InAppNotificationViewBinder for modal notifications.

Syntax: public func createNotificationView() -> InAppNotificationViewBinder

Returns: A new instance of InAppNotificationViewBinder configured for modal notifications.

Sample Code

let factory = InAppNotificationModalViewBinderFactory()
let modalNotificationView = factory.createNotificationView()

In the example above, a new instance of InAppNotificationViewBinder configured for modal notifications is created using the factory.

InAppNotificationBannerViewBinderFactory

This class is responsible for creating instances of InAppNotificationViewBinder for banner notifications.

Properties

Methods

createNotificationView()

Creates a new instance of InAppNotificationViewBinder for banner notifications.

Syntax: public func createNotificationView() -> InAppNotificationViewBinder

Returns: A new instance of InAppNotificationViewBinder configured for banner notifications.

let factory = InAppNotificationBannerViewBinderFactory()
let bannerNotificationView = factory.createNotificationView()

In the example above, a new instance of InAppNotificationViewBinder configured for banner notifications is created using the factory.

Styles

InAppNotificationViewStyle

This class represents the style configuration for an in-app notification view.

Properties:

Initialization: The init() method initializes the notification view style with default values.

Sample Code:

let style = InAppNotificationViewStyle()
style.titleTextColor = .blue
style.titleTextFont = UIFont.boldSystemFont(ofSize: 18)
style.backgroundColor = .white

In the example above, an instance of InAppNotificationViewStyle is created and its properties are configured with custom values.

InAppNotificationButtonStyle

This class represents the style configuration for a button in an in-app notification.

Properties

Initialization: The init()method initializes the notification button style with default values.

Sample Code:

let buttonStyle = InAppNotificationButtonStyle()

buttonStyle.buttonTextColor = .white

buttonStyle.buttonTintColor = .blue

buttonStyle.buttonType = .system

buttonStyle.buttonBackgroundColor = .gray

In the example above, an instance of InAppNotificationButtonStyle is created and its properties are configured with custom values.

InAppNotificationBannerViewStyle

This class represents the style configuration for a banner notification view, which is a subclass of InAppNotificationViewStyle.

Properties

Methods:

init()

Initializes the banner notification view style with default values.

Syntax: public override init()

init(darkThemeStyle:)

Initializes the banner notification view style with dark theme style.

Syntax: public init(darkThemeStyle: Bool)

Parameters

init(lightThemeStyle:)

Initializes the banner notification view style with light theme style as a convenience initializer.

Syntax: public convenience init(lightThemeStyle: Bool)

Parameters

Sample Code

// Create a banner notification view style with default values
let bannerStyle = InAppNotificationBannerViewStyle()
// Create a banner notification view style with dark theme style
let darkBannerStyle = InAppNotificationBannerViewStyle(darkThemeStyle: true)
// Create a banner notification view style with light theme style
let lightBannerStyle = InAppNotificationBannerViewStyle(lightThemeStyle: true)

InAppNotificationModalViewStyle

This class represents the style configuration for a modal notification view, which is a subclass of InAppNotificationViewStyle. Currently, it does not have any additional properties or methods, inheriting all properties and methods from InAppNotificationViewStyle.

Methods

init()

Initializes the modal notification view style with default values.

Syntax: public override init()

init(darkThemeStyle:)

Initializes the modal notification view style with dark theme style.

Syntax: public init(darkThemeStyle: Bool)

Parameters

init(lightThemeStyle:)

Initializes the modal notification view style with light theme style as a convenience initializer.

Syntax: public convenience init(lightThemeStyle: Bool)

Parameters

Sample Code

// Create a modal notification view style with default values
let modalStyle = InAppNotificationModalViewStyle()
// Create a modal notification view style with dark theme style
let darkModalStyle = InAppNotificationModalViewStyle(darkThemeStyle: true)
// Create a modal notification view style with light theme style
let lightModalStyle = InAppNotificationModalViewStyle(lightThemeStyle: true)

Enums

InAppNotificationTheme

This enumeration defines the themes available for in-app notifications: dark and light.

PushMessageStatus

This enumeration represents the status of a push message.

PushDisplayType

This enumeration represents the display type of a push message.

PushTokenType

This enumeration represents the type of push notification tokens that can be used within the application.