"src/embrace" | react-native-embrace

Index

Variables

Functions

Variables

Const ERROR

ERROR: "error" = "error"

Const INFO

INFO: "info" = "info"

Const WARNING

WARNING: "warning" = "warning"

Functions

Const addBreadcrumb

addBreadcrumb(message: string): void

Parameters
- message: string
Returns void

Const addSessionProperty

addSessionProperty(key: string, value: string, permanent: boolean): Promise<boolean>

Parameters
- key: string
- value: string
- permanent: boolean
Returns Promise<boolean>

Const addUserPersona

addUserPersona(persona: string): void

Parameters
- persona: string
Returns void

Const applyNetworkInterceptors

applyNetworkInterceptors(networkSDKInstance: NETWORK_INTERCEPTOR_TYPES): 0 | 1

Parameters
- networkSDKInstance: NETWORK_INTERCEPTOR_TYPES
Returns 0 | 1

Const clearAllUserPersonas

clearAllUserPersonas(): void

Returns void

Const clearUserAsPayer

clearUserAsPayer(): void

Returns void

Const clearUserEmail

clearUserEmail(): void

Returns void

Const clearUserIdentifier

clearUserIdentifier(): void

Returns void

Const clearUserPersona

clearUserPersona(persona: string): void

Parameters
- persona: string
Returns void

Const clearUsername

clearUsername(): void

Returns void

Const endAppStartup

endAppStartup(properties?: Properties): void

Parameters
- Optional properties: Properties
Returns void

Const endMoment

endMoment(name: string, identifier?: undefined | string, properties?: Properties): void

Parameters
- name: string
- Optional identifier: undefined | string
- Optional properties: Properties
Returns void

Const endSession

endSession(clearUserInfo?: boolean): any

Parameters
- Default value clearUserInfo: boolean = false
Returns any

Const endView

endView(view: string): void

Parameters
- view: string
Returns void

Const generateStackTrace

generateStackTrace(): string

Returns string

Const getCurrentSessionId

getCurrentSessionId(): Promise<string>

Returns Promise<string>

Const getDeviceId

getDeviceId(): string

Returns string

Const getLastRunEndState

getLastRunEndState(): Promise<SessionStatus>

Returns Promise<SessionStatus>

Const getSessionProperties

getSessionProperties(): any

Returns any

Const initialize

initialize(__namedParameters?: { patch: undefined | string }): void

Parameters
- Default value __namedParameters: { patch: undefined | string } = {}
  - patch: undefined | string
Returns void

Const logBreadcrumb

logBreadcrumb(message: string): void

deprecated

Use addBreadcrumb() instead. This API will be removed in a future release.

Parameters
- message: string
Returns void

Const logError

logError(message: string): void

Parameters
- message: string
Returns void

Const logHandledError

logHandledError(error: Error, properties?: Properties): void

Parameters
- error: Error
- Optional properties: Properties
Returns void

Const logInfo

logInfo(message: string): void

Parameters
- message: string
Returns void

Const logMessage

logMessage(message: string, severity?: "info" | "warning" | "error", properties?: Properties, allowScreenshot?: boolean): void

Parameters
- message: string
- Default value severity: "info" | "warning" | "error" = "error"
- Optional properties: Properties
- Default value allowScreenshot: boolean = false
Returns void

Const logNetworkClientError

logNetworkClientError(url: string, httpMethod: MethodType, startInMillis: number, endInMillis: number, errorType: string, errorMessage: string): void

Parameters
- url: string
- httpMethod: MethodType
- startInMillis: number
- endInMillis: number
- errorType: string
- errorMessage: string
Returns void

Const logNetworkRequest

logNetworkRequest(url: string, httpMethod: MethodType, startInMillis: number, endInMillis: number, bytesSent: number, bytesReceived: number, statusCode: number, error?: undefined | string): void

deprecated

Use recordNetworkRequest() instead. This API will be removed in a future release.

Parameters
- url: string
- httpMethod: MethodType
- startInMillis: number
- endInMillis: number
- bytesSent: number
- bytesReceived: number
- statusCode: number
- Optional error: undefined | string
Returns void

Const logScreen

logScreen(screenName: string): void

Parameters
- screenName: string
Returns void

Const logWarning

logWarning(message: string): void

Parameters
- message: string
Returns void

Const recordNetworkRequest

recordNetworkRequest(url: string, httpMethod: MethodType, startInMillis: number, endInMillis: number, bytesSent?: undefined | number, bytesReceived?: undefined | number, statusCode?: undefined | number, error?: undefined | string): void

Parameters
- url: string
- httpMethod: MethodType
- startInMillis: number
- endInMillis: number
- Optional bytesSent: undefined | number
- Optional bytesReceived: undefined | number
- Optional statusCode: undefined | number
- Optional error: undefined | string
Returns void

Const removeSessionProperty

removeSessionProperty(key: string): void

Parameters
- key: string
Returns void

Const setJavaScriptBundlePath

setJavaScriptBundlePath(path: string): void

Parameters
- path: string
Returns void

Const setJavaScriptPatch

setJavaScriptPatch(patch: string): void

Parameters
- patch: string
Returns void

Const setUserAsPayer

setUserAsPayer(): void

Returns void

Const setUserEmail

setUserEmail(userEmail: string): void

Parameters
- userEmail: string
Returns void

Const setUserIdentifier

setUserIdentifier(userIdentifier: string): void

Parameters
- userIdentifier: string
Returns void

Const setUserPersona

setUserPersona(persona: string): void

deprecated

Use addUserPersona() instead. This API will be removed in a future release.

Parameters
- persona: string
Returns void

Const setUsername

setUsername(username: string): void

Parameters
- username: string
Returns void

Const startMoment

startMoment(name: string, identifier?: undefined | string, properties?: Properties): void

Parameters
- name: string
- Optional identifier: undefined | string
- Optional properties: Properties
Returns void

Const startMomentAllowingScreenshot

startMomentAllowingScreenshot(name: string, allowScreenshot: boolean, identifier?: undefined | string, properties?: Properties): void

deprecated

Use startMoment() instead. This API will be removed in a future release.

Parameters
- name: string
- allowScreenshot: boolean
- Optional identifier: undefined | string
- Optional properties: Properties
Returns void

Const startView

startView(view: string): void

Parameters
- view: string
Returns void

Generated using TypeDoc