Navigation
API > API/Runtime > API/Runtime/Analytics > API/Runtime/Analytics/IAnalyticsProvider
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool StartSession () |
Starts a session. | Interfaces/IAnalyticsProvider.h | |
bool StartSession
(
const TArray< FAnalyticsEventAttribute >& Attributes |
Starts a session. See parameterless-version for contract details. | Interfaces/IAnalyticsProvider.h | |
bool StartSession
(
const FAnalyticsEventAttribute& Attribute |
Overload for StartSession that takes a single attribute | Interfaces/IAnalyticsProvider.h | |
bool StartSession
(
const FString& ParamName, |
Overload for StartSession that takes a single name/value pair | Interfaces/IAnalyticsProvider.h |
StartSession()
Description
Starts a session. It's technically legal to send events without starting a session. The use case is for backends and dedicated servers to send events on behalf of a user without technically affecting the session length of the local player. Local players log in and start/end the session, but remote players simply call SetUserID and start sending events, which is legal and analytics providers should gracefully handle this. Repeated calls to this method will be ignored.
| Name | StartSession |
| Type | function |
| Header File | /Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h |
| Include Path | #include "Interfaces/IAnalyticsProvider.h" |
bool StartSession()
true if the session started successfully.
StartSession(const TArray< FAnalyticsEventAttribute > &)
Description
Starts a session. See parameterless-version for contract details.
| Name | StartSession |
| Type | function |
| Header File | /Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h |
| Include Path | #include "Interfaces/IAnalyticsProvider.h" |
bool StartSession
(
const TArray < FAnalyticsEventAttribute > & Attributes
)
Parameters
| Name | Remarks |
|---|---|
| Attributes | attributes of the session. Arbitrary set of key/value pairs that will be sent with the StartSession event that this should also trigger. |
StartSession(const FAnalyticsEventAttribute &)
Description
Overload for StartSession that takes a single attribute
| Name | StartSession |
| Type | function |
| Header File | /Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h |
| Include Path | #include "Interfaces/IAnalyticsProvider.h" |
bool StartSession
(
const FAnalyticsEventAttribute & Attribute
)
Parameters
| Name | Remarks |
|---|---|
| Attribute | attribute name and value |
StartSession(const FString &, const FString &)
Description
Overload for StartSession that takes a single name/value pair
| Name | StartSession |
| Type | function |
| Header File | /Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h |
| Include Path | #include "Interfaces/IAnalyticsProvider.h" |
bool StartSession
(
const FString & ParamName,
const FString & ParamValue
)
Parameters
| Name | Remarks |
|---|---|
| ParamName | attribute name |
| ParamValue | attribute value |