デリゲートモジュール | モジュール

使用法

デリゲートモジュールは、デリゲートがディスパッチイベントの監視や抑制を可能にするマルチキャストデリゲートハンドラを提供します。このモジュールの使用は任意です。個々のディスパッチ/イベントに対して細かい制御が必要な場合にのみ使用します。例えば、イベントの送信をブロックしたり、トラッキング呼び出しの成功/失敗を監視するためなどです。

以下のプラットフォームがサポートされています:

iOS
tvOS
watchOS
macOS

インストール

CocoaPodsまたはCarthageでDelegateモジュールをインストールします。

CocoaPods

CocoaPodsでDelegateモジュールをインストールするには、以下のpodをPodfileに追加します:

pod 'tealium-swift/TealiumDelegate'

フレームワークは自動的にインスタンス化されます。TealiumCore podに依存性があります。iOSのCocoaPodsインストールについてはこちらをご覧ください。

Carthage

CarthageでDelegateモジュールをインストールするには、以下の手順を実行します:

Xcodeでアプリターゲットの一般構成ページに移動します。
次のフレームワークをEmbedded Binariesセクションに追加します:
```
TealiumDelegate.framework
```
トラッキングデリゲートを構成するには、プロジェクトに以下の必要なインポート文を追加します:
```
import TealiumDelegate
```

フレームワークは自動的にインスタンス化されます。TealiumCoreに依存性があります。追加のインポート文は必要ありません。iOSのCarthageインストールについてはこちらをご覧ください。

データレイヤー

このモジュールによって追加の変数は導入されません。

APIリファレンス

`add()`

TealiumDelegateプロトコルに準拠するクラスインスタンスへの弱いポインタを追加します。

add(delegate)

パラメータ	タイプ	説明	例
`delegate`	`TealiumDelegate`	TealiumDelegateプロトコルに準拠する任意のクラス	`delegate:self`

`remove()`

TealiumDelegateプロトコルに準拠する指定されたクラスへの弱いポインタ参照を削除します。

remove(delegate)

パラメータ	タイプ	説明	例
`delegate`	`TealiumDelegate`	TealiumDelegateプロトコルに準拠する任意のクラス	`delegate:self`

`removeAll()`

トラッキングからすべての弱いポインタを削除します。

removeAll()

`tealiumShouldTrack()`

メソッドがtrueを返す場合、トラッキング呼び出しは完了することが許可されます。メソッドがfalseを返す場合、トラッキング呼び出しはキャンセルされます。

tealiumShouldTrack(data: [String:Any]) -> Bool

パラメータ	説明	例
`data`	`[String:Any]`	`["somekey" : "somevalue"]`

`tealiumTrackCompleted()`

完了したトラック呼び出しの監視とエラーの処理を可能にします。

tealiumTrackCompleted(success: Bool, info: [String:Any]?, error: Error?)

パラメータ	タイプ	説明	例
`success`	`Bool`	ディスパッチが適切に完了したかどうか	[`"true"`, `"false"`]
`info`	`[String:Any]`	元のペイロードの辞書とディスパッチに関する他の返されたデータ	`["somekey" : "somevalue"]`
`error`	`Error`	ディスパッチ処理中に遭遇したエラー（ある場合）	`TealiumCollectError.xErrorDetected`