Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 3.62 KB

README.md

File metadata and controls

76 lines (48 loc) · 3.62 KB
Raw

analytics-swift Carthage compatible

analytics-swift is an Swift client for Segment.

Our analytics-ios library is more full featured than it's Swift counterpart. You can use analytics-ios from a Swift project.

The analytics-ios library supports the following features that are NOT offered in the Swift library:

  • Queing events offline. Without this, the swift library will drop events once the user closes the app or when the user is offline.
  • Client side integrations. Without this, some integrations (such as Flurry, Localytics and others) cannot be used with the Swift library.

Installing the Library

CocoaPods

use_frameworks!

pod 'AnalyticsSwift', '~> 0.2.0'

Manual

  1. Download the latest binary of the library.
  2. Drag the AnalyticsSwift.framework file into your project.
  3. Under 'Build Phases', click the 'New Copy Files Phase' button.
  4. In the 'Copy Files' target, select 'Frameworks' as the destination and drag the Analytics.framework file from the binary we added to the project in step 2.

Usage

  • Add the AnalyticsSwift library to your project.

  • Add the correct imports import AnalyticsSwift

  • Create an instance of the analytics client with your project write key:

var analytics = Analytics.create(YOUR_SEGMENT_WRITE_KEY_HERE)

var message = TrackMessageBuilder(event: "Button A").userId("prateek")

  • Enqueue the message.

analytics.enqueue(message)

  • Wait for the message to be uploaded or trigger a flush manually.

analytics.flush()

Examples

You can see basic examples of the library in action here.

License

WWWWWW||WWWWWW
 W W W||W W W
      ||
    ( OO )__________
     /  |           \
    /o o|    MIT     \
    \___/||_||__||_|| *
         || ||  || ||
        _||_|| _||_||
       (__|__|(__|__|


(The MIT License)

Copyright (c) 2013 Segment Inc. <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.