Skip to end of metadata
Go to start of metadata

Last Updated: Monday, September 28, 2020



The following documentation shows you how to Install the iOS Push Notifications SDK.


Installing the iOS Push Notifications SDK (v.3+)

You can install the iOS Push Notifications SDK by using dependency managers or by manually integrating it.

Requirements

  • iOS 9 - iOS 14
  • Xcode 8.0 - Xcode 10.0+
  • CocoaPods 1.1.0+

Swift Version Support


The SDK is Swift version dependent.   You will need to verify the deployment target matches that of your application target.  Ensure that the Swift Version (from Build settings) of the VibesPush target is supported in the version you cloned.

SDK Version

Swift Version Supported

4.2.05.0
4.1.05.0
4.0.04.2

3.3.0

4.2

3.2.0

4.0

3.1.0

3.0

Dependency Manager

CocoaPods

CocoaPods is a dependency manager for Cocoa projects that you can use to install the Vibes Push Notifications iOS SDK.

  1. Install CocoaPods using the following command:

    $ gem install cocoapods
  2. Verify that it is properly instead installed using this command. 

    $ pod --version
  3. If your app is using a tracking identifiers, you will have already included AdSupport.framework.   

  4. Integrate VibesPush into your Xcode project using CocoaPods by specifying the following in your Podfile.

    platform :ios, '9.0' 
    use_frameworks! 
    pod 'VibesPush',  '4.0.0'
    
  5. Run the following command to install the library:

    $ pod install

Carthage

Starting with versions 3.2.0, you can also use Carthage to install our SDK.

  1. If you do not have Carthage installed, use either of the methods below to install:
    1. Using Homebrew (http://brew.sh/

      brew install carthage
    2.  Downloading Carthage.pkg installer from https://github.com/Carthage/Carthage/releases

  2. After Carthage is installed, create a Cartfile in your project root directory and add the following line in your Cartfile.

    github "Vibes/push-sdk-ios" == 4.0.0
  3. Run the following command:

    carthage update --platform iOS
  4. Open the folder Carthage on your project root directory and navigate into Build/iOS. Drag the VibesPush.framework into the Linked Frameworks and Libraries section in Build Settings of your Xcode project.

Manual Installation

If you prefer not to use CocoaPods. you can integrate Vibes Push SDK into your project manually.

Embedded Framework

You can manually embed the Vibes Push SDK framework into your project.

  1. Open up Terminal and run the following command to clone the VibesPush SDK into your local environment:

    $ git clone https://github.com/vibes/push-sdk-ios.git
  2. Open the directory where you have cloned VibesPush, and drag the VibesPush.xcodeproj into the Project Navigator of your application's Xcode project.

  3. Select the VibesPush.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.  Ensure that the Swift Version (from Build settings) of the VibesPush target is supported in the version you cloned.
  4. Select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the Targets heading in the sidebar.
  5. Open the General panel In the tabbed bar at the top of the window.
  6. Click on the + button under the Embedded Binaries section.
  7. Choose the VibesPush.framework and select add.

Git Submodule

You can install VibesPush SDK as a git submodule of your project.

  1. Open up Terminal, cd into your top-level project directory, and run the following command if your project is not initialized as a git repository

    $ git init
  2. Add VibesPush SDK as a git submodule by running the following command:

    $ git submodule add https://github.com/vibes/push-sdk-ios.git
  3. Open the new VibesPush folder, and drag the VibesPush.xcodeproj into the Project Navigator of your application's Xcode project.
  4. Select the VibesPush.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.
  5. Select your application project in the Project Navigator to navigate to the target configuration window and select the application target under the Targets heading in the sidebar.
  6. Open the General panel In the tabbed bar at the top of the window.
  7. Click on the + button under the Embedded Binaries section.
  8. Choose the VibesPush.framework and select addThe VibesPush.framework is added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.


  • No labels