Cizen

v0.9.1

Cizen v0.9.1 Cizen.EventFilter View Source

Filter events.

Link to this section Summary

Types

t()

Functions

new(params \\ [])

Returns new event filter

test(event_filter, event)

Test event by the given filter

Link to this section Types

Link to this type t() View Source 
t() :: %Cizen.EventFilter{
  event_body_filter_set: Cizen.EventBodyFilterSet.t() | nil,
  event_type: Cizen.EventType.t() | nil,
  source_saga_filter_set: Cizen.SagaFilterSet.t() | nil,
  source_saga_id: Cizen.SagaID.t() | nil,
  source_saga_module: module() | nil
}

Link to this section Functions

Link to this macro new(params \\ []) View Source (macro)

Returns new event filter.

The following keys are used to create an event filter, and all of them are optional:

  • :event_type - an event type.
  • :source_saga_id - a saga ID.
  • :event_body_filters - a list of event body filters.
Link to this function test(event_filter, event) View Source 
test(Cizen.EventFilter.t(), Cizen.Event.t()) :: boolean()

Test event by the given filter.