ApiEventsFactory 2.10.1 API

All Implemented Interfaces:


public final class ApiEventsFactory

Factory class used to create API events.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`ApiEventsFactory(ConfigurationRepository configurationRepository, ConsentRepository consentRepository, OrganizationUserRepository organizationUserRepository, UserAgentRepository userAgentRepository, UserRepository userRepository, ContextHelper contextHelper)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final List<ApiEvent>`	`createConsentGivenEvents(ConsentGivenApiEventParameters parameters)`	Create a list containing an API event, and additional events for synchronized users if needed.
`final ApiEvent`	`create(ApiEventType eventType, ApiEventParameters parameters, UserAuth organizationUserOverride, Boolean includeUserId)`	Generic method used to create API events.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ApiEventsFactory
```
ApiEventsFactory(ConfigurationRepository configurationRepository, ConsentRepository consentRepository, OrganizationUserRepository organizationUserRepository, UserAgentRepository userAgentRepository, UserRepository userRepository, ContextHelper contextHelper)
```
- Method Detail
  - createConsentGivenEvents
```
 final List<ApiEvent> createConsentGivenEvents(ConsentGivenApiEventParameters parameters)
```
    Create a list containing an API event, and additional events for synchronized users if needed.
    
    Parameters:
    
    parameters - the optional event parameters.
    
    Returns:
    
    a newly created event.
  - create
```
 final ApiEvent create(ApiEventType eventType, ApiEventParameters parameters, UserAuth organizationUserOverride, Boolean includeUserId)
```
    Generic method used to create API events.
    
    Parameters:
    
    eventType - type of the event to be created.
    
    parameters - the optional event parameters.
    
    organizationUserOverride - optional, specific organizationUserId to use for this event
    
    includeUserId - whether to include the user id in the event, default is true.
    
    Returns:
    
    a newly created event.