Hydrogen Framework  1.3.1
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
hTestFlight Class Reference

A drop in implementation of the Hydrogen.Plugins.TestFlight manager. It implements advanced features included with TestFlight allowing for proper session tracking and reporting. More...

+ Inheritance diagram for hTestFlight:

Public Member Functions

void AddCustomEnvironmentInformation (string key, string data)
 Adds an entry into the Key-Value store for this TestFlight session. More...
 
void Log (string message)
 Send a message to TestFlight to appear in it's console. More...
 
void LogAsync (string message)
 Send a message to TestFlight asynchronously to appear in it's console. More...
 
void PassCheckpoint (string checkpoint)
 Report to TestFlight that the session has passed a Checkpoint. More...
 
void SubmitFeedback (string message)
 Submits a feedback message for the App to TestFlight. More...
 

Static Public Member Functions

static bool Exists ()
 Does a TestFlight manager instance exist? More...
 

Public Attributes

bool Persistent = true
 Should this TestFlight manager survive scene switches. More...
 
string TokenAndroid = ""
 The TestFlight token for Android. More...
 
string TokenIOS = ""
 The TestFlight token iOS. More...
 

Properties

static hTestFlight Instance [get]
 Gets the TestFlight interface instance. More...
 

Detailed Description

A drop in implementation of the Hydrogen.Plugins.TestFlight manager. It implements advanced features included with TestFlight allowing for proper session tracking and reporting.

Definition at line 37 of file hTestFlight.cs.

Member Function Documentation

void hTestFlight.AddCustomEnvironmentInformation ( string  key,
string  data 
)

Adds an entry into the Key-Value store for this TestFlight session.

Parameters
keyThe Key.
dataThe Value.

Definition at line 107 of file hTestFlight.cs.

108  {
109  // Make sure that we are infact flying and there is a session present, if not we'll dump out a
110  // message to console if on a platform where this should have worked.
111  if (!Hydrogen.Plugins.TestFlight.Flying || !Hydrogen.Plugins.TestFlight.Session) {
112 
113  #if (UNITY_IPHONE || UNITY_IOS || UNITY_ANDROID) && !UNITY_EDITOR
114  Debug.Log ("Unable to send information, TestFlight is not in flight.");
115  #endif
116 
117  return;
118  }
119 
120  // Notice that the data/key is swapped here. Not to sure why TestFlight decided on this format,
121  // it really seems backwards.
122  Hydrogen.Plugins.TestFlight.AddCustomEnvironmentInformation (data, key);
123  }
static bool hTestFlight.Exists ( )
static

Does a TestFlight manager instance exist?

Definition at line 96 of file hTestFlight.cs.

97  {
98  return _staticInstance != null;
99  }
void hTestFlight.Log ( string  message)

Send a message to TestFlight to appear in it's console.

Parameters
messageThe Message.

Definition at line 129 of file hTestFlight.cs.

130  {
131  // Make sure that we are infact flying and there is a session present, if not we'll dump out a
132  // message to console if on a platform where this should have worked.
133  if (!Hydrogen.Plugins.TestFlight.Flying || !Hydrogen.Plugins.TestFlight.Session) {
134  #if (UNITY_IPHONE || UNITY_IOS || UNITY_ANDROID) && !UNITY_EDITOR
135  Debug.Log ("Unable to send log data, TestFlight is not in flight.");
136  #endif
137  return;
138  }
139 
140  Hydrogen.Plugins.TestFlight.Log (message);
141  }
void hTestFlight.LogAsync ( string  message)

Send a message to TestFlight asynchronously to appear in it's console.

Parameters
messageThe Message.

Definition at line 147 of file hTestFlight.cs.

148  {
149  // Make sure that we are infact flying and there is a session present, if not we'll dump out a
150  // message to console if on a platform where this should have worked.
151  if (!Hydrogen.Plugins.TestFlight.Flying || !Hydrogen.Plugins.TestFlight.Session) {
152  #if (UNITY_IPHONE || UNITY_IOS || UNITY_ANDROID) && !UNITY_EDITOR
153  Debug.Log ("Unable to send log data, TestFlight is not in flight.");
154  #endif
155  return;
156  }
157 
158  Hydrogen.Plugins.TestFlight.LogAsync (message);
159  }
void hTestFlight.PassCheckpoint ( string  checkpoint)

Report to TestFlight that the session has passed a Checkpoint.

Parameters
checkpointThe Checkpoint name.

Definition at line 165 of file hTestFlight.cs.

166  {
167  // Make sure that we are infact flying and there is a session present, if not we'll dump out a
168  // message to console if on a platform where this should have worked.
169  if (!Hydrogen.Plugins.TestFlight.Flying || !Hydrogen.Plugins.TestFlight.Session) {
170  #if (UNITY_IPHONE || UNITY_IOS || UNITY_ANDROID) && !UNITY_EDITOR
171  Debug.Log ("Unable to send checkpoint data, TestFlight is not in flight.");
172  #endif
173  return;
174  }
175 
176  Hydrogen.Plugins.TestFlight.PassCheckpoint (checkpoint);
177  }
void hTestFlight.SubmitFeedback ( string  message)

Submits a feedback message for the App to TestFlight.

Parameters
messageThe feedback message.

Definition at line 183 of file hTestFlight.cs.

184  {
185  // Make sure that we are infact flying and there is a session present, if not we'll dump out a
186  // message to console if on a platform where this should have worked.
187  if (!Hydrogen.Plugins.TestFlight.Flying || !Hydrogen.Plugins.TestFlight.Session) {
188  #if (UNITY_IPHONE || UNITY_IOS || UNITY_ANDROID) && !UNITY_EDITOR
189  Debug.Log ("Unable to submit feedback, TestFlight is not in flight.");
190  #endif
191  return;
192  }
193 
194  Hydrogen.Plugins.TestFlight.SubmitFeedback (message);
195  }

Member Data Documentation

bool hTestFlight.Persistent = true

Should this TestFlight manager survive scene switches.

Definition at line 42 of file hTestFlight.cs.

string hTestFlight.TokenAndroid = ""

The TestFlight token for Android.

Definition at line 46 of file hTestFlight.cs.

string hTestFlight.TokenIOS = ""

The TestFlight token iOS.

Definition at line 50 of file hTestFlight.cs.

Property Documentation

hTestFlight hTestFlight.Instance
staticget

Gets the TestFlight interface instance.

The TestFlight interface

Definition at line 72 of file hTestFlight.cs.