GCountly (opensdk API)

java.lang.Object
- cn.com.ecarx.gcountly.opensdk.GCountly

public class GCountly
extends java.lang.Object

Created by zhanghao. 2017/5/18-10:10

方法概要

All Methods Static Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`void`	`addCrashLog(java.lang.String record)` Add crash breadcrumb like log record to the log that will be send together with crash report
`void`	`changeDeviceId(java.lang.String deviceId)` Changes current device id to the one specified in parameter.
`void`	`enableCrashReporting()` Enable crash reporting to send unhandled crash reports to server
`void`	`enableParameterTamperingProtection(java.lang.String salt)`
`boolean`	`endEvent(java.lang.String key)` End timed event with a specified key
`boolean`	`endEvent(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> segmentation, int count, double sum)` End timed event with a specified key
`static GCountly`	`getInstance()`
`void`	`halt()` Immediately disables session & event tracking and clears any stored session & event data.
`void`	`init(android.content.Context context, GCountlyConfig gCountlyConfig)`
`void`	`init(android.content.Context context, java.lang.String serverUrl, java.lang.String appKey, java.lang.String deviceId)`
`boolean`	`isLoggingEnabled()`
`boolean`	`isViewTrackingEnabled()`
`void`	`logException(java.lang.Exception exception)` Log handled exception to report it to server as non fatal crash
`void`	`onCreate(android.app.Activity activity)`
`void`	`onStart(android.app.Activity activity)`
`void`	`onStop()`
`void`	`recordEvent(java.lang.String key)`
`void`	`recordEvent(java.lang.String key, int count)`
`void`	`recordEvent(java.lang.String key, int count, double sum)`
`void`	`recordEvent(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> segmentation, int count)`
`void`	`recordEvent(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> segmentation, int count, double sum)`
`void`	`recordEvent(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> segmentation, int count, double sum, double dur)`
`void`	`recordView(java.lang.String viewName)`
`void`	`setCustomCrashSegments(java.util.Map<java.lang.String,java.lang.String> segments)` Sets custom segments to be reported with crash reports In custom segments you can provide any string key values to segments crashes by
`void`	`setCustomUserData(java.util.Map<java.lang.String,java.lang.String> customdata)`
`void`	`setDisableUpdateSessionRequests(boolean disable)` Disable periodic session time updates.
`void`	`setEventQueueSizeToSend(int size)`
`void`	`setLocation(double lat, double lon)`
`void`	`setLoggingEnabled(boolean enableLogging)`
`void`	`setUserData(java.util.Map<java.lang.String,java.lang.String> data)`
`void`	`setUserData(java.util.Map<java.lang.String,java.lang.String> data, java.util.Map<java.lang.String,java.lang.String> customdata)`
`void`	`setViewTracking(boolean enable)`
`boolean`	`startEvent(java.lang.String key)` Start timed event with a specified key

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getInstance
```
public static GCountly getInstance()
```
  - init
```
public void init(android.content.Context context,
                 GCountlyConfig gCountlyConfig)
```
  - init
```
public void init(android.content.Context context,
                 java.lang.String serverUrl,
                 java.lang.String appKey,
                 java.lang.String deviceId)
```
  - recordEvent
```
public void recordEvent(java.lang.String key)
```
  - recordEvent
```
public void recordEvent(java.lang.String key,
                        int count)
```
  - recordEvent
```
public void recordEvent(java.lang.String key,
                        int count,
                        double sum)
```
  - recordEvent
```
public void recordEvent(java.lang.String key,
                        java.util.Map<java.lang.String,java.lang.String> segmentation,
                        int count)
```
  - recordEvent
```
public void recordEvent(java.lang.String key,
                        java.util.Map<java.lang.String,java.lang.String> segmentation,
                        int count,
                        double sum)
```
  - recordEvent
```
public void recordEvent(java.lang.String key,
                        java.util.Map<java.lang.String,java.lang.String> segmentation,
                        int count,
                        double sum,
                        double dur)
```
  - onCreate
```
public void onCreate(android.app.Activity activity)
```
  - onStart
```
public void onStart(android.app.Activity activity)
```
  - onStop
```
public void onStop()
```
  - setViewTracking
```
public void setViewTracking(boolean enable)
```
  - isViewTrackingEnabled
```
public boolean isViewTrackingEnabled()
```
  - recordView
```
public void recordView(java.lang.String viewName)
```
  - setUserData
```
public void setUserData(java.util.Map<java.lang.String,java.lang.String> data)
```
  - setUserData
```
public void setUserData(java.util.Map<java.lang.String,java.lang.String> data,
                        java.util.Map<java.lang.String,java.lang.String> customdata)
```
  - setCustomUserData
```
public void setCustomUserData(java.util.Map<java.lang.String,java.lang.String> customdata)
```
  - setLocation
```
public void setLocation(double lat,
                        double lon)
```
  - setCustomCrashSegments
```
public void setCustomCrashSegments(java.util.Map<java.lang.String,java.lang.String> segments)
```
    Sets custom segments to be reported with crash reports In custom segments you can provide any string key values to segments crashes by
    
    参数:
    
    segments - Map<String, String> key segments and their values
  - addCrashLog
```
public void addCrashLog(java.lang.String record)
```
    Add crash breadcrumb like log record to the log that will be send together with crash report
    
    参数:
    
    record - String a bread crumb for the crash report
  - logException
```
public void logException(java.lang.Exception exception)
```
    Log handled exception to report it to server as non fatal crash
    
    参数:
    
    exception - Exception to log
  - enableCrashReporting
```
public void enableCrashReporting()
```
    Enable crash reporting to send unhandled crash reports to server
  - startEvent
```
public boolean startEvent(java.lang.String key)
```
    Start timed event with a specified key
    
    参数:
    
    key - name of the custom event, required, must not be the empty string or null
    
    返回:
    
    true if no event with this key existed before and event is started, false otherwise
  - endEvent
```
public boolean endEvent(java.lang.String key)
```
    End timed event with a specified key
    
    参数:
    
    key - name of the custom event, required, must not be the empty string or null
    
    返回:
    
    true if event with this key has been previously started, false otherwise
  - endEvent
```
public boolean endEvent(java.lang.String key,
                        java.util.Map<java.lang.String,java.lang.String> segmentation,
                        int count,
                        double sum)
```
    End timed event with a specified key
    
    参数:
    
    key - name of the custom event, required, must not be the empty string
    
    segmentation - segmentation dictionary to associate with the event, can be null
    
    count - count to associate with the event, should be more than zero
    
    sum - sum to associate with the event
    
    返回:
    
    true if event with this key has been previously started, false otherwise
    
    抛出:
    
    java.lang.IllegalStateException - if ICount SDK has not been initialized
    
    java.lang.IllegalArgumentException - if key is null or empty, count is less than 1, or if segmentation contains null or empty keys or values
  - setDisableUpdateSessionRequests
```
public void setDisableUpdateSessionRequests(boolean disable)
```
    Disable periodic session time updates. By default, ICount will send a request to the server each 30 seconds with a small update containing session duration time. This method allows you to disable such behavior. Note that event updates will still be sent every 10 events or 30 seconds after event recording.
    
    参数:
    
    disable - whether or not to disable session time updates instance for easy method chaining
  - enableParameterTamperingProtection
```
public void enableParameterTamperingProtection(java.lang.String salt)
```
  - setLoggingEnabled
```
public void setLoggingEnabled(boolean enableLogging)
```
  - isLoggingEnabled
```
public boolean isLoggingEnabled()
```
  - setEventQueueSizeToSend
```
public void setEventQueueSizeToSend(int size)
```
  - halt
```
public void halt()
```
    Immediately disables session & event tracking and clears any stored session & event data. This API is useful if your app has a tracking opt-out switch, and you want to immediately disable tracking when a user opts out. The onStart/onStop/recordEvent methods will throw IllegalStateException after calling this until Countly is reinitialized by calling init again.
  - changeDeviceId
```
public void changeDeviceId(java.lang.String deviceId)
```
    Changes current device id to the one specified in parameter. Merges user profile with new id (if any) with old profile.
    
    参数:
    
    deviceId - new device id

类 GCountly

方法概要

从类继承的方法 java.lang.Object

方法详细资料

getInstance

init

init

recordEvent

recordEvent

recordEvent

recordEvent

recordEvent

recordEvent

onCreate

onStart

onStop

setViewTracking

isViewTrackingEnabled

recordView

setUserData

setUserData

setCustomUserData

setLocation

setCustomCrashSegments

addCrashLog

logException

enableCrashReporting

startEvent

endEvent

endEvent

setDisableUpdateSessionRequests

enableParameterTamperingProtection

setLoggingEnabled

isLoggingEnabled

setEventQueueSizeToSend

halt

changeDeviceId