Interface IUserReportingPlatform
Represents a user reporting platform.
Namespace: Unity.Cloud.UserReporting.Client
Assembly: Unity.Cloud.UserReporting.Client.dll
Syntax
public interface IUserReportingPlatform
Methods
DeserializeJson<T>(String)
Deserialized the specified JSON.
Declaration
T DeserializeJson<T>(string json)
Parameters
Type | Name | Description |
---|---|---|
System.String | json | The JSON. |
Returns
Type | Description |
---|---|
T | The deserialized object instance. |
Type Parameters
Name | Description |
---|---|
T | The type. |
GetDeviceMetadata()
Gets device metadata.
Declaration
IDictionary<string, string> GetDeviceMetadata()
Returns
Type | Description |
---|---|
System.Collections.Generic.IDictionary<System.String, System.String> | Device metadata. |
ModifyUserReport(UserReport)
Modifies a user report.
Declaration
void ModifyUserReport(UserReport userReport)
Parameters
Type | Name | Description |
---|---|---|
UserReport | userReport | The user report. |
OnEndOfFrame(UserReportingClient)
Called at the end of a frame.
Declaration
void OnEndOfFrame(UserReportingClient client)
Parameters
Type | Name | Description |
---|---|---|
UserReportingClient | client | The client. |
Post(String, String, Byte[], Action<Single, Single>, Action<Boolean, Byte[]>)
Posts to an endpoint.
Declaration
void Post(string endpoint, string contentType, byte[] content, Action<float, float> progressCallback, Action<bool, byte[]> callback)
Parameters
Type | Name | Description |
---|---|---|
System.String | endpoint | The endpoint. |
System.String | contentType | The content type. |
System.Byte[] | content | The content. |
System.Action<System.Single, System.Single> | progressCallback | The progress callback. Provides the upload and download progress. |
System.Action<System.Boolean, System.Byte[]> | callback | The callback. Provides a value indicating whether the post was successful and provides the resulting byte array. |
SendAnalyticsEvent(String, Dictionary<String, Object>)
Sends an analytics event.
Declaration
void SendAnalyticsEvent(string eventName, Dictionary<string, object> eventData)
Parameters
Type | Name | Description |
---|---|---|
System.String | eventName | The event name. |
System.Collections.Generic.Dictionary<System.String, System.Object> | eventData | The event data. |
SerializeJson(Object)
Serializes the specified object instance.
Declaration
string SerializeJson(object instance)
Parameters
Type | Name | Description |
---|---|---|
System.Object | instance | The object instance. |
Returns
Type | Description |
---|---|
System.String | The JSON. |
TakeScreenshot(Int32, Int32, Int32, Object, Action<Int32, Byte[]>)
Takes a screenshot.
Declaration
void TakeScreenshot(int frameNumber, int maximumWidth, int maximumHeight, object source, Action<int, byte[]> callback)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | frameNumber | The frame number. |
System.Int32 | maximumWidth | The maximum width. |
System.Int32 | maximumHeight | The maximum height. |
System.Object | source | The source. Passing null will capture the screen. Passing a camera will capture the camera's view. Passing a render texture will capture the render texture. |
System.Action<System.Int32, System.Byte[]> | callback | The callback. Provides the screenshot. |
Update(UserReportingClient)
Called on update.
Declaration
void Update(UserReportingClient client)
Parameters
Type | Name | Description |
---|---|---|
UserReportingClient | client | The client. |