RemoteNotification

@objc(KRTRemoteNotification)
public class RemoteNotification : NSObject
extension RemoteNotification: Library

リモート通知メッセージのパースおよびメッセージ中に含まれるディープリンクのハンドリングを行うためのクラスです。

  • 通知のクリック計測を自動で行うかどうかを表すフラグを返します。
    フラグを false にした場合は、自動でのクリック計測が行われません。
    デフォルトは true です。

    本フラグの設定は KarteApp.setup(appKey:) を呼び出す前に行う必要があります。

    Declaration

    Swift

    @available(*, deprecated, renamed: "RemoteNotificationConfiguration.isEnabledAutoMeasurement")
@objc
public class var isEnabledAutoMeasurement: Bool { get set }
  • url

    通知メッセージ中に含まれる URL を返します。 以下の場合は、nil を返します。

    • KARTE以外から送信されたメッセージ
    • メッセージ中に URL が含まれていない場合
    • 不正なURL

    Declaration

    Swift

    @objc
public var url: URL? { get }

  • インスタンスを初期化します。 なおリモート通知メッセージが KARTE から送信されたメッセージでない場合は、nil を返します。

    Declaration

    Swift

    @objc
public init?(userInfo: [AnyHashable : Any])

    Parameters

    userInfo

    リモート通知メッセージ

  • ローダークラスが Objective-Cランライムに追加されたタイミングで呼び出されるメソッドです。 本メソッドが呼び出されたタイミングで、KarteApp クラスに本クラスをライブラリとして登録します。

    Declaration

    Swift

    @objc
public class func _krt_load()

  • リモート通知メッセージに含まれるディープリンクを処理します。 内部では、メッセージ中に含まれるURLを UIApplication.open(_:options:completionHandler:) に渡す処理を行っています。

    UIApplication.open(_:options:completionHandler:) の呼び出しが行われた場合は true を返し、メッセージ中にURLが含まれない場合は false を返します。

    Declaration

    Swift

    @discardableResult
@objc
public func handle() -> Bool

  • 通知のクリック計測を行います。
    通常は自動でクリック計測が行われるため本メソッドを呼び出す必要はありませんが、 isEnabledAutoMeasurement が false の場合は自動での計測が行われないため、 本メソッドを呼び出す必要があります。

    Declaration

    Swift

    @objc
public func track()

  • Declaration

    Swift

    public static var name: String { get }

  • Declaration

    Swift

    public static var version: String { get }

  • Declaration

    Swift

    public static var isPublic: Bool { get }

  • Declaration

    Swift

    public static func configure(app: KarteApp)

  • Declaration

    Swift

    public static func unconfigure(app: KarteApp)