The following API allows you to control when the session gets recorded.
Start recording
Starts the UXCam application to ping the server, get the settings configurations and start capturing the data according to the configuration.
Use startWithKey with appVariantIdentifier parameter to separate Debug and Release builds.
SDK 3.0.0 and above
+ (void) startWithKey:(NSString*) userAPIKey;
+ (void) startWithKey:(NSString*)userAPIKey
buildIdentifier:(NSString*)appVariant;
SDK below 3.0.0
+ (void) startWithKey:(NSString*) applicationKey;
+ (void) startWithKey:(NSString*)applicationKey appVariantIdentifier:(NSString*)appVariant;SDK 3.0.0 and above
UXCam.startWithKey (String userAPIKey)
SDK below 3.0.0
UXCam.startWithKey(UXCamKey);
UXCam.startWithKey(UXCamKey, buildIdentifier);
UXCam.StartWithKey(UXCamKey);
UXCam.startWithKey(UXCamKey);
The API parameters are:
applicationKey / userAPIKey: App-key (found on UXCam dashboard)
appVariantIdentifier / buildIdentifier: nil by default, pass parameters appVariantIdentifier or buildIdentifier to separate Debug and Release builds
Stop recording
Stops the UXCam application and sends captured data to the server. Use this to start sending the data on UXCam server without the app going on background.
SDK 3.0.0 and above (void) stopSessionAndUploadData;
SDK below 3.0.0+ (void) stopApplicationAndUploadData;
SDK 3.0.0 and above
UXCam.stopApplicationAndUploadSession();
SDK below 3.0.0
UXCam.stopApplicationAndUploadData();
UXCam.StopSessionAndUploadData();
UXCam.stopSessionAndUploadData();Allow short break for another app
Prevent a short trip to another app causing a break in a session
+(void) allowShortBreakForAnotherApp:(BOOL)continueSession;
UXCam.allowShortBreakForAnotherApp()
** call UXCam.resumeShortBreakForAnotherApp() to resume from short break
** By default the method will wait 180000ms (3min) to end the session, if you want to specify the time call UXCam.allowShortBreakForAnotherApp(int timeInMillis)UXCam.AllowShortBreakForAnotherApp(continueSession)
** Android only: call UXCam.ResumeShortBreakForAnotherApp() to resume from short break
UXCam.allowShortBreakForAnotherApp(continueSession)
** call UXCam.resumeShortBreakForAnotherApp() to resume from short break
The API parameters are:
continueSession: Set to TRUE to continue the current session after a short trip out to another app. Default is FALSE - stops the session as soon as the app enters the background.
Cancel recording
Cancels the recording of the current session and discards the data.
+ (void) cancelCurrentSession;
SDK 3.0.0 and above
UXCam.cancelCurrentSession()
SDK below 3.0.0
UXCam.cancelRecording()
UXCam.cancelSession()UXCam.CancelCurrentSession()
UXCam.cancelCurrentSession()
Add verification listener
Doesn't exist on iOS - pass it in to startWithKey
UXCam.addVerificationListener(OnVerificationListener listener)
Example:
UXCam.addVerificationListener(new OnVerificationListener() {
@Override
public void onVerificationSuccess() {
//Do Something here
}
@Override
public void onVerificationFailed(String errorMessage) {
//Do Something here
}
});UXCam.AddVerificationListener(OnVerificationListener listener)
Example:
UXCam.AddVerificationListener(new IOnVerificationListener());
class IOnVerificationListener : Java.Lang.Object, Com.UXCam.IOnVerificationListener
{
public void OnVerificationFailed(string p0)
{
//Do Something here
}
public void OnVerificationSuccess()
{
//Do Something here
}
}
UXCam.addVerificationListener(OnVerificationListener listener)
Example:
UXCam.addVerificationListener(verificationSuccess);
function verificationSuccess() {
UXCam.urlForCurrentUser(function(link){
//Do Something here
});
UXCam.urlForCurrentSession(function(link){
//Do something here
});
}
Remove verification listener
Doesn't exist on iOS
UXCam.removeVerificationListener(OnVerificationListener listener)UXCam.RemoveVerificationListener(OnVerificationListener listener)
UXCam.removeVerificationListener(OnVerificationListener listener)
Get Multisession Record
Get whether UXCam is set to automatically record a new session when the app resumes from the background.
+ (BOOL) getMultiSessionRecord;
boolean getMultiSessionRecord()boolean GetMultiSessionRecord()
boolean getMultiSessionRecord()
Set Multisession Record
Set whether to automatically record multiple sessions or not.
+ (void) setMultiSessionRecord:(BOOL)recordMultipleSessions;
void setMultiSessionRecord(boolean multiSessionRecord)void SetMultiSessionRecord()
void setMultiSessionRecord()
Delete pending records
Deletes any sessions that are awaiting upload
+ (void) deletePendingUploads;
+ (NSUInteger) pendingUploads;
void deletePendingUploads()
int pendingSessionCount();void DeletePendingUploads()
int PendingSessionCount()
void deletePendingUploads()
int pendingSessionCount()
Upload pending session
Begins upload of any pending sessions.
void uploadPendingSession()
void uploadPendingSession(Callback callback)
NOIOS Only:
void UploadPendingSession()
void UploadPendingSession(Callback callback)
IOS only:
void uploadPendingSession()
void uploadPendingSession(Callback callback)