Skip to content

Add alias for Swift docs #3324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stayseesong merged 4 commits into from
Aug 4, 2022
Merged

Add alias for Swift docs #3324

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
450c2a1
Add alias method
Aug 3, 2022
7b680a2
Add alias method
Aug 3, 2022
6f1ce58
Update src/connections/sources/catalog/libraries/mobile/swift-ios/ind…
stayseesong Aug 3, 2022
7d81a4c
fixes
stayseesong Aug 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion src/connections/sources/catalog/libraries/mobile/swift-ios/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To get started with the Analytics-Swift mobile library:

```swift
var analytics: Analytics? = nil

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// Override point for customization after application launch.
let configuration = Configuration(writeKey: "WRITE_KEY")
Expand Down Expand Up @@ -68,6 +68,7 @@ Once you've installed the Analytics-Swift library, you can start collecting data
- [Track](#track)
- [Screen](#screen)
- [Group](#group)
- [Alias](#alias)

### Identify
The [Identify](/docs/connections/spec/identify/) method lets you tie a user to their actions and record traits about them. This includes a unique user ID and any optional traits you know about them like their email, name, address. The traits option can include any information you want to tie to the user. When using any of the reserved traits, be sure the information reflects the name of the trait. For example, `email` should always be a string of the user's email address.
Expand Down Expand Up @@ -186,6 +187,23 @@ analytics.group(groupId: "user-123", traits: MyTraits(
{% endcodeexampletab %}
{% endcodeexample %}

### Alias
The [Alias](/docs/connections/spec/alias/) method is used to merge two user identities, effectively connecting two sets of user data as one. When this method is called, the `newId` value overwrites the old `userId`. If no `userId` is currently set, the `newId` associates with future events as the `userId`. This is an advanced method and may not be supported across the entire destination catalog.

{% codeexample %}
{% codeexampletab Method signature %}
```swift
func alias(newId: String)
```
{% endcodeexampletab %}

{% codeexampletab Example use %}
```swift
analytics.alias(newId: "user-123")
```
{% endcodeexampletab %}
{% endcodeexample %}

## Plugin Architecture
Segment's plugin architecture enables you to modify and augment how the analytics client works. From modifying event payloads to changing analytics functionality, plugins help to speed up the process of getting things done.

Expand Down