Events

NubrickEvent

送信された NubrickEvent は、Nubrickサーバーに送信されます。

NubrickEvent は、NubrickClient.dispatch が呼び出された際にディスパッチされるイベントです。このイベントがディスパッチされると、NubrickClient.overlay がイベントに一致したポップアップ実験を表示します。

Definition

public struct NubrickEvent {
    public init(_ name: String)
}

NubrickEvent インスタンスを使って、NubrickClient.dispatch を呼び出すことで NubrickEvent をディスパッチできます：

nubrickClient.dispatch(event: NubrickEvent("<TRIGGER_EVENT_NAME>"))

ComponentEvent

ComponentEvent は、エクスペリメントにユーザーがアクションしたときにディスパッチされるイベントです。 例えば、ユーザーがエクスペリメント内でボタンをタップした際、ComponentEvent がディスパッチされ、そのプロパティが定義されます。

ComponentEvent は、NubrickClient または NubrickExperiment.embedding を初期化する際に onEvent 引数を使ってリッスンできます。

定義

public struct ComponentEvent {
    public let name: String?
    public let destinationPageId: String?
    public let deepLink: String?
    public let payload: [EventProperty]?
}

public struct EventProperty {
    public let name: String
    public let value: String
    public let type: EventPropertyType
}

public enum EventPropertyType {
    case INTEGER
    case STRING
    case TIMESTAMPZ
    case UNKNOWN
}