Skip to content

Commit a16901f

Browse files
zhu-xiaoweixiaoweii
andauthored
chore: update doc for api change (#16)
Co-authored-by: xiaoweii <xiaoweii@amazom.com>
1 parent 6d9cf53 commit a16901f

File tree

3 files changed

+8
-9
lines changed

3 files changed

+8
-9
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -132,10 +132,10 @@ let attributes: ClickstreamAttribute = [
132132
"ProcessDuration": 12.33,
133133
"UserAge": 20,
134134
]
135-
ClickstreamAnalytics.recordEvent(eventName: "testEvent", attributes: attributes)
135+
ClickstreamAnalytics.recordEvent("testEvent", attributes)
136136

137137
// for record an event directly
138-
ClickstreamAnalytics.recordEvent(eventName: "button_click")
138+
ClickstreamAnalytics.recordEvent("button_click")
139139
```
140140

141141
#### Add global attribute
@@ -149,10 +149,10 @@ let globalAttribute: ClickstreamAttribute = [
149149
"level": 5.1,
150150
"isOpenNotification": true,
151151
]
152-
ClickstreamAnalytics.addGlobalAttributes(attributes: globalAttribute)
152+
ClickstreamAnalytics.addGlobalAttributes(globalAttribute)
153153

154154
// for delete an global attribute
155-
ClickstreamAnalytics.deleteGlobalAttributes(attributes: "level")
155+
ClickstreamAnalytics.deleteGlobalAttributes("level")
156156
```
157157

158158
#### Login and logout
@@ -161,10 +161,10 @@ ClickstreamAnalytics.deleteGlobalAttributes(attributes: "level")
161161
import Clickstream
162162

163163
// when user login usccess.
164-
ClickstreamAnalytics.setUserId(userId: "userId")
164+
ClickstreamAnalytics.setUserId("userId")
165165

166166
// when user logout
167-
ClickstreamAnalytics.setUserId(userId: nil)
167+
ClickstreamAnalytics.setUserId(nil)
168168
```
169169

170170
When we log into another user, we will clear the before user's user attributes, after `setUserId()` you need to add new user's attribute.
@@ -178,7 +178,7 @@ let userAttributes : ClickstreamAttribute=[
178178
"_user_age": 21,
179179
"_user_name": "carl"
180180
]
181-
ClickstreamAnalytics.addUserAttributes(attributes: userAttributes)
181+
ClickstreamAnalytics.addUserAttributes(userAttributes)
182182
```
183183

184184
Current login user‘s attributes will be cached in disk, so the next time app launch you don't need to set all user's attribute again, of course you can update the current user's attribute when it changes.

Sources/Clickstream/ClickstreamObjc.swift

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import Foundation
99

1010
/// ClickstreamAnalytics api for objective-c
1111
@objcMembers public class ClickstreamObjc: NSObject {
12-
1312
/// Hide the constructor
1413
@nonobjc
1514
override private init() {

Tests/ClickstreamTests/IntegrationTest.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class IntegrationTest: XCTestCase {
3737
"appId": appId,
3838
"endpoint": "http://localhost:8080/collect",
3939
"isCompressEvents": false,
40-
"autoFlushEventsInterval": 10000,
40+
"autoFlushEventsInterval": 10_000,
4141
"isTrackAppExceptionEvents": false
4242
]
4343
]

0 commit comments

Comments
 (0)