React Native SDK
At a glance
Group
Function
Initialization
initialize(config: AmplyInitializationConfig): Promise<void>
initialize(config: AmplyInitializationConfig): Promise<void>Name
Type
Required
Description
isInitialized(): boolean
isInitialized(): booleanEvent tracking
track(payload: TrackEventPayload): Promise<void>
track(payload: TrackEventPayload): Promise<void>Name
Type
Required
Description
Gating
trackGated(event: string, properties?: Record<string, CustomPropertyValue>): Promise<GateDecision>
trackGated(event: string, properties?: Record<string, CustomPropertyValue>): Promise<GateDecision>Name
Type
Required
Description
registerGate(baseUrl: string, presenter: GatePresenter, options?: GateOptions): Promise<() => void>
registerGate(baseUrl: string, presenter: GatePresenter, options?: GateOptions): Promise<() => void>Name
Type
Required
Description
GateDecision
GateDecisionShape
Meaning
Resolution (presenter callback)
User attributes
setUserId(userId: string | null): void
setUserId(userId: string | null): voidName
Type
Required
Description
setCustomProperty(key: string, value: CustomPropertyValue): void
setCustomProperty(key: string, value: CustomPropertyValue): voidName
Type
Required
Description
setCustomProperties(properties: Record<string, CustomPropertyValue>): void
setCustomProperties(properties: Record<string, CustomPropertyValue>): voidName
Type
Required
Description
getCustomProperty(key: string): Promise<CustomPropertyValue | null>
getCustomProperty(key: string): Promise<CustomPropertyValue | null>Name
Type
Required
Description
removeCustomProperty(key: string): void
removeCustomProperty(key: string): voidName
Type
Required
Description
clearCustomProperties(): void
clearCustomProperties(): voidDeeplinks
addDeepLinkListener(listener: (event: DeepLinkEvent) => void): Promise<() => void>
addDeepLinkListener(listener: (event: DeepLinkEvent) => void): Promise<() => void>Name
Type
Required
Description
System events
addSystemEventListener(listener: (event: EventRecord) => void): Promise<() => void>
addSystemEventListener(listener: (event: EventRecord) => void): Promise<() => void>Name
Type
Required
Description
addSystemEventsListener(listener: (event: EventRecord) => void): Promise<() => void>
addSystemEventsListener(listener: (event: EventRecord) => void): Promise<() => void>systemEvents.addListener(listener: (event: EventRecord) => void): Promise<() => void>
systemEvents.addListener(listener: (event: EventRecord) => void): Promise<() => void>useAmplySystemEvents(options?: UseAmplySystemEventsOptions): UseAmplySystemEventsResult
useAmplySystemEvents(options?: UseAmplySystemEventsOptions): UseAmplySystemEventsResultName
Type
Required
Description
Data inspection
getRecentEvents(limit: number): Promise<EventRecord[]>
getRecentEvents(limit: number): Promise<EventRecord[]>Name
Type
Required
Description
getDataSetSnapshot(type: DataSetType): Promise<DataSetSnapshot>
getDataSetSnapshot(type: DataSetType): Promise<DataSetSnapshot>Name
Type
Required
Description
Logging
setLogLevel(level: LogLevel): void
setLogLevel(level: LogLevel): voidName
Type
Required
Description
getLogLevel(): LogLevel
getLogLevel(): LogLevelUtilities
formatSystemEventLabel(event: EventRecord, options?: FormatOptions): string
formatSystemEventLabel(event: EventRecord, options?: FormatOptions): stringName
Type
Required
Description
removeAllListeners(): void
removeAllListeners(): voidTypes
AmplyInitializationConfig
AmplyInitializationConfigField
Required
Description
TrackEventPayload
TrackEventPayloadEventRecord
EventRecordDeepLinkEvent
DeepLinkEventDataSetType
DataSetTypeCustomPropertyValue
CustomPropertyValueLogLevel
LogLevelSystem event names
Related
Last updated