Class KraangRequestPayloadFormatter

Formats data in an acceptable manner for Kraang analytics requests, including payload signatures.

Inheritance

Object

KraangRequestPayloadFormatter

Namespace: IdleKit.Analytics.Kraang

Assembly: cs.temp.dll.dll

Syntax

public class KraangRequestPayloadFormatter : IInjectable

Fields

_actionService

Declaration

protected IActionService _actionService

Field Value

Type	Description
IActionService

_appId

Declaration

protected string _appId

Field Value

Type	Description
String

_appInformation

Declaration

protected IAppInformation _appInformation

Field Value

Type	Description
IAppInformation

_authenticator

Declaration

protected KraangAuthenticator _authenticator

Field Value

Type	Description
KraangAuthenticator

_platform

Declaration

protected string _platform

Field Value

Type	Description
String

_signingSecret

Declaration

protected string _signingSecret

Field Value

Type	Description
String

_version

Declaration

protected string _version

Field Value

Type	Description
String

APP_ID_KEY

Declaration

public const string APP_ID_KEY = "app"

Field Value

Type	Description
String

APP_VERSION_KEY

Declaration

public const string APP_VERSION_KEY = "version"

Field Value

Type	Description
String

PLATFORM_KEY

Declaration

public const string PLATFORM_KEY = "platform"

Field Value

Type	Description
String

SIGNATURE_KEY

Declaration

public const string SIGNATURE_KEY = "signature"

Field Value

Type	Description
String

Methods

FormatBatchedEventDatas(List<Dictionary<String, Object>>)

Batched Events are flattened into a JSON array of objects.

Declaration

protected virtual string FormatBatchedEventDatas(List<Dictionary<string, object>> nestedEventDatas)

Parameters

Type	Name	Description
List<Dictionary<String, Object>>	nestedEventDatas

Returns

Type	Description
String

FormatData(Dictionary<String, Object>, Boolean)

Format all event data into string keys and values.

Declaration

public virtual Hashtable FormatData(Dictionary<string, object> eventData, bool forceNoEscape = false)

Parameters

Type	Name	Description
Dictionary<String, Object>	eventData
Boolean	forceNoEscape

Returns

Type	Description
Hashtable

FormatNestedData(Hashtable, Boolean)

Returns data as a simple a JSON object.

Declaration

protected virtual string FormatNestedData(Hashtable data, bool forceNoEscape)

Parameters

Type	Name	Description
Hashtable	data	The data to format.
Boolean	forceNoEscape	If true, quotes in the data will not be escaped.

Returns

Type	Description
String

Initialize(String, String)

Declaration

public void Initialize(string appId, string signingSecret)

Parameters

Type	Name	Description
String	appId
String	signingSecret

Inject(IResolver)

Declaration

public void Inject(IResolver resolver)

Parameters

Type	Name	Description
IResolver	resolver

InjectCommonData(IDictionary)

Adds data that every event needs.

Declaration

public virtual void InjectCommonData(IDictionary eventData)

Parameters

Type	Name	Description
IDictionary	eventData	The event data to add data to.

SignEventData(IDictionary, IDictionary)

Create a signature using sourceData and store that signature into targetData.

Declaration

public virtual void SignEventData(IDictionary sourceData, IDictionary targetData = null)

Parameters

Type	Name	Description
IDictionary	sourceData	The payload data used to generate a signature.
IDictionary	targetData	The payload to write the signature into.

Remarks

If no targetData is provided, the signature will be written to sourceData.