no.nordicsemi.android.log

Class LocalLogSession

java.lang.Object

no.nordicsemi.android.log.LocalLogSession

All Implemented Interfaces:

ILogSession

public class LocalLogSession
extends java.lang.Object
implements ILogSession

If the nRF Logger application is not installed on the phone/tablet application may still use the logger functionality with it's own provider. LocalLogSession is a limited version of LogSession, it does not keep the application data. The local provider does not allow to mark sessions or add descriptions.

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the session and all its entries from the local database.
android.content.Context	getContext() Returns the application context.
android.net.Uri	getSessionContentUri() Returns the session read-only content Uri.
android.net.Uri	getSessionEntriesUri() Returns the session entries Uri.
android.net.Uri	getSessionUri() Returns the session Uri.
static LocalLogSession	newSession(android.content.Context context, android.net.Uri authority, java.lang.String key, java.lang.String name) Creates new logger session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newSession

public static LocalLogSession newSession(@NonNull
                                         android.content.Context context,
                                         @NonNull
                                         android.net.Uri authority,
                                         @NonNull
                                         java.lang.String key,
                                         @NonNull
                                         java.lang.String name)

Creates new logger session. Must be created before appending log entries. If the nRF Logger application is not installed the method will return null.

Parameters:

context - the context (activity, service or application)

authority - the LocalLogContentProvider authority

key - the session key, which is used to group sessions

name - the human readable session name

Returns:

the LogContract that can be used to append log entries or null if MCP is not installed. The null value can be next passed to logging methods

delete

public void delete()

Deletes the session and all its entries from the local database.

getContext

@NonNull
public android.content.Context getContext()

Description copied from interface: ILogSession

Returns the application context.

Specified by:

getContext in interface ILogSession

Returns:

The context.

getSessionUri

@NonNull
public android.net.Uri getSessionUri()

Description copied from interface: ILogSession

Returns the session Uri. The Uri may be saved in Activity.onSaveInstanceState(android.os.Bundle) to recreate the session using Logger.openSession(Context, Uri) when orientation change. Use this Uri also to open the log session in the nRF Logger.

 Intent intent = new Intent(Intent.ACTION_VIEW, mLogSession.getSessionUri());
 startActivity(intent);
 

Specified by:

getSessionUri in interface ILogSession

Returns:

The session Uri.

getSessionEntriesUri

@NonNull
public android.net.Uri getSessionEntriesUri()

Description copied from interface: ILogSession

Returns the session entries Uri. New log entries may be inserted using this Uri.

Specified by:

getSessionEntriesUri in interface ILogSession

Returns:

The session entries Uri.

getSessionContentUri

@NonNull
public android.net.Uri getSessionContentUri()

Description copied from interface: ILogSession

Returns the session read-only content Uri. It can be used to obtain all log entries in a single row (as a String field) with fixed syntax, e.g.:

 [Application name], [Creation date]
 [Session name] ([Session key])
 D      10.34.01.124    This is the oldest log message (debug)
 V      10.34.02.238    This is the log message (verbose)
 I      10.34.03.527    This is the log message (info)
 A      10.34.04.612    This is the log message (application)
 W      10.34.04.812    This is the log message (warning)
 E      10.34.05.452    This is the newest log message (error)
 

Specified by:

getSessionContentUri in interface ILogSession

Returns:

The Uri that can be read using ContentResolver.query(Uri, String[], String, String[], String) method. The value will be in the first row, column number 0 (with id: LogContract.Session.Content.CONTENT).