CPPushService

@objc
public class CPPushService : NSObject

Manages push notifications and notifies relevant service.

Since

1.0.0

  • Configuration of the Push Manager.

    Declaration

    Swift

    @objc
public var userInfo: CPUserInfo!

    Return Value

    CPUserInfo

  • Push Subscription Blocks are invoked when push subscription operations are called.

    Declaration

    Swift

    public typealias PushSubscriptionBlock = (_ error: CPError?, _ callbackURL: String?) -> ()

    Parameters

    error

    If operation fails returns as CPError, otherwise returns nil
    channelInfo

    If operation succeeds, returns callbackURL to use push management operations.

  • Push Ubsubscription Block is invoked when unsubscription operations are called.

    Declaration

    Swift

    public typealias PushUnsubscriptionBlock = (_ error: CPError?) -> ()

    Parameters

    error

    If operation fails returns as CPError, otherwise returns nil

  • Initializes Push Manager instance with given configuration.

    Declaration

    Swift

    public init(userInfo: CPUserInfo, services: [CPServiceProtocol])

    Parameters

    userInfo

    User Information
    services

    Array of services that the application has configured for use.

Public connection methods

  • Subscribes Push Services with the given configuration.

    Declaration

    Swift

    @objc
public func subscribe(completion: @escaping PushSubscriptionBlock)

    Parameters

    completion

    Invokes PushSubscriptionBlock when operation is finished

  • Unsubscribe from the Push Service with the given callback URL.

    Declaration

    Swift

    @objc
public func unsubscribe(completion: @escaping PushUnsubscriptionBlock)

    Parameters

    ofURL

    Callback URL of the push service
    completion

    Invokes PushSubscriptionBlock when operation is finished

  • Checks Push Service Subscription whether subscribed or not. If any push subscription continues, completion block returns with the Callback URL.

    Declaration

    Swift

    @objc
public func checkPushSubscription(completion: @escaping PushSubscriptionBlock)

    Parameters

    completion

    Invokes PushSubscriptionBlock when operation is finished

  • When push message arrived injectPushMessage should be called. Notifies services to act according to the message.

    Declaration

    Swift

    @objc
public func injectPushMessage(pushMessage: [AnyHashable : Any], completion: @escaping (_ error: CPError?) -> Void)

    Parameters

    pushMessage

    The push message string taken from payload.

  • Resubscribes to Push Services with the given device token

    Declaration

    Swift

    @objc
public func refreshDeviceToken(_ standardDeviceToken: String, voipDeviceToken: String, completion: @escaping PushSubscriptionBlock)

    Parameters

    standardDeviceToken

    The device token to use subscription operations.
    voipDeviceToken

    The device token to use subscription operations.
    completion

    Invokes PushSubscriptionBlock when operation is finished

  • Parses the incoming call push data for reporting call kit

    Since

    2.5.0

    Declaration

    Swift

    @objc
public func parsePushNotification(pushMessage: [AnyHashable : Any]) -> CPCKInfo

    Parameters

    pushMessage

    Incoming push data

    Return Value

    CPCKInfo