Skip to content

Latest commit

 

History

History
363 lines (217 loc) · 10.6 KB

analytics.client.md

File metadata and controls

363 lines (217 loc) · 10.6 KB
Raw

@segment/analytics-react-native > Client

Class: Client

Hierarchy

Client

Index

Properties

Methods

Properties

ready

● ready: false = false

Defined in analytics.ts:147

Whether the client is ready to send events to Segment.

This becomes true when .setup() succeeds. All calls will be queued until it becomes true.

Methods

alias

▸ alias(newId: string, options?: Options): Promise<void>

Defined in analytics.ts:325

Merge two user identities, effectively connecting two sets of user data as one. This may not be supported by all integrations.

When you learn more about who the group is, you can record that information with group.

Parameters:

Name Type Default value Description
newId string - The new ID you want to alias the existing ID to. The existing ID will be either the previousId if you have called identify, or the anonymous ID.
Default value options Options {}

Returns: Promise<void>

catch

▸ catch(handler: ErrorHandler): this

Defined in analytics.ts:162

Catch React-Native bridge errors

These errors are emitted when calling the native counterpart. This only applies to methods with no return value (Promise<void>), methods like getAnonymousId do reject promises.

Parameters:

Name Type
handler ErrorHandler

Returns: this

disable

▸ disable(): Promise<void>

Defined in analytics.ts:364

Completely disable the sending of any analytics data.

If you have a way for users to actively or passively (sometimes based on location) opt-out of analytics data collection, you can use this method to turn off all data collection.

Returns: Promise<void>

enable

▸ enable(): Promise<void>

Defined in analytics.ts:354

Enable the sending of analytics data. Enabled by default.

Occasionally used in conjunction with disable user opt-out handling.

Returns: Promise<void>

flush

▸ flush(): Promise<void>

Defined in analytics.ts:345

Trigger an upload of all queued events.

This is useful when you want to force all messages queued on the device to be uploaded. Please note that not all integrations respond to this method.

Returns: Promise<void>

getAnonymousId

▸ getAnonymousId(): Promise<string>

Defined in analytics.ts:369

Retrieve the anonymousId.

Returns: Promise<string>

group

▸ group(groupId: string, traits?: JsonMap, options?: Options): Promise<void>

Defined in analytics.ts:312

Associate a user with a group, organization, company, project, or w/e you call them.

When you learn more about who the group is, you can record that information with group.

Parameters:

Name Type Default value Description
groupId string - A database ID for this group.
Default value traits JsonMap {} A dictionary of traits you know about the group. Things like: name, employees, etc.
Default value options Options {} A dictionary of options, e.g. integrations (thigh analytics integration to forward the event to)

Returns: Promise<void>

identify

▸ identify(user: string, traits?: JsonMap, options?: Options): Promise<void>

Defined in analytics.ts:299

Associate a user with their unique ID and record traits about them.

When you learn more about who your user is, you can record that information with identify.

Parameters:

Name Type Default value Description
user string - database ID (or email address) for this user. If you don't have a userId but want to record traits, you should pass nil. For more information on how we generate the UUID and Apple's policies on IDs, see https://segment.io/libraries/ios#ids
Default value traits JsonMap {} A dictionary of traits you know about the user. Things like: email, name, plan, etc.
Default value options Options {} A dictionary of options, e.g. integrations (thigh analytics integration to forward the event to)

Returns: Promise<void>

middleware

▸ middleware(middleware: Middleware): this

Defined in analytics.ts:208

Append a new middleware to the middleware chain.

Middlewares are a powerful mechanism that can augment the events collected by the SDK. A middleware is a simple function that is invoked by the Segment SDK and can be used to monitor, modify or reject events.

Middlewares are invoked for all events, including automatically tracked events, and external event sources like Adjust and Optimizely. This offers you the ability the customize those messages to fit your use case even if the event was sent outside your source code.

The key thing to observe here is that the output produced by the first middleware feeds into the second. This allows you to chain and compose independent middlewares!

For example, you might want to record the device year class with your events. Previously, you would have to do this everywhere you trigger an event with the Segment SDK. With middlewares, you can do this in a single place :

import DeviceYearClass from 'react-native-device-year-class'

analytics.middleware(async ({next, context}) =>
  next({
    ...context,
    device_year_class: await DeviceYearClass()
  })
)

Parameters:

Name Type Description
middleware Middleware

Returns: this

reset

▸ reset(): Promise<void>

Defined in analytics.ts:335

Reset any user state that is cached on the device.

This is useful when a user logs out and you want to clear the identity. It will clear any traits or userId's cached on the device.

Returns: Promise<void>

screen

▸ screen(name: string, properties?: JsonMap, options?: Options): Promise<void>

Defined in analytics.ts:284

Record the screens or views your users see.

When a user views a screen in your app, you'll want to record that here. For some tools like Google Analytics and Flurry, screen views are treated specially, and are different from "events" kind of like "page views" on the web. For services that don't treat "screen views" specially, we map "screen" straight to "track" with the same parameters. For example, Mixpanel doesn't treat "screen views" any differently. So a call to "screen" will be tracked as a normal event in Mixpanel, but get sent to Google Analytics and Flurry as a "screen".

Parameters:

Name Type Default value Description
name string - The title of the screen being viewed. We recommend using human-readable names like 'Photo Feed' or 'Completed Purchase Screen'.
Default value properties JsonMap {} A dictionary of properties for the screen view event. If the event was 'Added to Shopping Cart', it might have properties like price, productType, etc.
Default value options Options {}

Returns: Promise<void>

setIDFA

▸ setIDFA(idfa: string): void

Defined in analytics.ts:172

Sets the IDFA value on iOS. Customers are now responsible for collecting IDFA on their own.

Parameters:

Name Type
idfa string

Returns: void

setup

▸ setup(writeKey: string, configuration?: Configuration): Promise<void>

Defined in analytics.ts:247

Setup the Analytics module. All calls made before are queued and only executed if the configuration was successful.

await analytics.setup('YOUR_WRITE_KEY', {
  using: [Mixpanel, GoogleAnalytics],
  trackAppLifecycleEvents: true,
  ios: {
    trackDeepLinks: true
  }
})

Parameters:

Name Type Default value Description
writeKey string - Your Segment.io write key
Default value configuration Configuration {} An optional Configuration object.

Returns: Promise<void>

track

▸ track(event: string, properties?: JsonMap, options?: Options): Promise<void>

Defined in analytics.ts:266

Record the actions your users perform.

When a user performs an action in your app, you'll want to track that action for later analysis. Use the event name to say what the user did, and properties to specify any interesting details of the action.

Parameters:

Name Type Default value Description
event string - The name of the event you're tracking. We recommend using human-readable names like `Played a Song` or `Updated Status`.
Default value properties JsonMap {} A dictionary of properties for the event. If the event was 'Added to Shopping Cart', it might have properties like price, productType, etc.
Default value options Options {} A dictionary of options, e.g. integrations (thigh analytics integration to forward the event to)

Returns: Promise<void>

useNativeConfiguration

▸ useNativeConfiguration(): this

Defined in analytics.ts:220

Use the native configuration.

You'll need to call this method when you configure Analytics's singleton using the native API.

Returns: this