イベント

public struct Events

Realm イベント記録は、Realm で実行されたすべての読み取りと書込みを記録し、サーバーに報告するために使用できます。 Realm を開くために使用されるRealm.ConfigurationのeventConfigurationプロパティを設定してイベント レコードを有効にし、 Realmでeventsプロパティを持つEventsインスタンスを取得します。

Githubでの表示

  • 指定されたアクティビティ名でイベントの記録を開始します。

    すべてのクエリとイベント スコープ内でインスタンス化されたすべてのオブジェクトは、スコープが終了すると「読み取り」イベントとして自動的に報告されます。 イベント スコープ内で変更されたすべてのオブジェクトは「書込み」イベントを生成し、オブジェクトの初期状態と変更されたすべてのプロパティの新しい値を報告します。

    宣言

    Swift

    public func beginScope(activity: String) -> Scope

    戻り値

    スコープをコミットまたはキャンセルするために使用されるスコープ オブジェクト。

    Githubでの表示

  • カスタム イベントを記録します。

    この関数は、イベントをローカルにディスクに保存し、非同期にサーバーに送信します。 オプションの 完了 関数は、イベント データが正常に保存されたときに呼び出され、実際のアップロードが完了したときに呼び出されません。

    この関数はイベント スコープとやり取りせず、アクティブなスコープなしで呼び出せます。

    宣言

    Swift

    public func recordEvent(activity: String, eventType: String? = nil, data: String? = nil,
                        completion: ((Swift.Error?) -> Void)? = nil)

    パラメーター

    activity

    アクティビティ名。 これは、 activityイベント プロパティに として保存される任意の string です。
    eventType

    イベントの種類。 これは、 eventTypeイベント プロパティに として保存される任意の string です。
    data

    このイベントのデータペイロード。 指定した場合、 dataイベント プロパティに保存されている string。 自動生成されたイベントはすべてこのフィールドに JSON を保存しますが、カスタム イベントではそのような必要がないことに注意してください。
    completion

    イベントが イベント Realm に保存されたか、エラーが発生した際に呼び出される任意の完了ハンドラー。 nil エラーは成功を示します。
    Githubでの表示

  • イベント構成で提供されているメタデータを新しい値に置き換えます。

    イベント スコープがアクティブなときに呼び出された場合、次のイベント スコープが開始されるまで新しいメタデータは使用されません。

    イベント メタデータの詳細については、 EventConfiguration.metadataを参照してください。

    宣言

    Swift

    public func updateMetadata(_ newMetadata: [String : String])
    Githubでの表示

  • アクティブなイベント スコープを表すオブジェクト。スコープをコミットまたはキャンセルするために使用できます。

    詳細はこちら

    宣言

    Swift

    public class Scope
    Githubでの表示

  • カスタム イベントを記録します。

    この関数は、イベントをローカルにディスクに保存し、非同期にサーバーに送信します。 返された未来は、イベント データが正常に保存された場合に実行され、実際のアップロードが完了した場合には実行されません。

    この関数はイベント スコープとやり取りせず、アクティブなスコープなしで呼び出せます。

    宣言

    Swift

    @_disfavoredOverload
func recordEvent(activity: String, eventType: String? = nil, data: String? = nil)
        -> Future<Void, Error>

    パラメーター

    activity

    アクティビティ名。 これは、 activityイベント プロパティに として保存される任意の string です。
    eventType

    イベントの種類。 これは、 eventTypeイベント プロパティに として保存される任意の string です。
    data

    このイベントのデータペイロード。 指定した場合、 dataイベント プロパティに保存されている string。 自動生成されたイベントはすべてこのフィールドに JSON を保存しますが、カスタム イベントではそのような必要がないことに注意してください。
    Githubでの表示