MobileConnectSDK - MobileConnect framework for iOS

The library is written in swift with full support for Objective C code base.

Requirements

• iOS 8.0+ / Mac OS X 10.9+ / tvOS 9.0+ / watchOS 2.0+
• Xcode 7.3+

Dependency Libraries

The library uses Alamofire and JSONModel libraries for rest service calls and deserialization. And you'll get them preconfigured if you follow the cocoa pods installation procedure described below.

Configuration

1) You'll have to have CocoaPods installed. In case you already installed it please pass to step 2

1.1) Open Terminal.

1.2) Enter $ sudo gem install cocoapods command in terminal.

1.3) Navigate to directory containing your Xcode project inside the terminal window by using cd “../directory-location/..” or cd [drag-and-drop project folder]

1.4) Pod install.

2) Configure pods file and install the framework itself

2.1) After running the "Pod Install" or "pod init" command in the terminal in the directory where your project resides open the newly created Podfile or the existing one and find your target specified. Right below your target specification please add the following lines

use_frameworks!
  pod 'MobileConnectSDK', :git => 'https://github.com/Dan-Andoni-BJSS/testsdk', :branch => ’master’

Ex: In my case I have the target of the application is named "Test2" and the podfile after modification will look like below:

# Uncomment this line to define a global platform for your project
# platform :ios, '9.0'

target 'Test2' do
  # Uncomment this line if you're using Swift or would like to use dynamic frameworks
  use_frameworks!
  pod 'MobileConnectSDK', :git => 'https://github.com/Mobile-Connect/ios-sdk-v2', :branch => ’master’


  # Pods for Test2

end

2.2) Save the pods file and in the terminal window navigate to your xcode project directory. After that type

pod update

3) Configure the framework inside your project

3.1) Add the framework in your targets app Linked Frameworks and Libraries

Press the pluss and in the list select the MobileConnectSDK.framework and then press add

As a result you'll have it added in the Linked Frameworks and Libraries section

In case you are having an Objective C code based project please set the "Allow Non-modular Includes in Framework Modules" flag to YES. (You can find this flag in your Projects Build Settings as shown in the image below)

In case your target builds against iOS 9+ please make sure you have added App Transport Security Settings to your target Info.plist. You can do that by opening the Info.plist as source code and pasting the below key inside the plist.

<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key><true/>
</dict>

Objective C:

At the beginning of the .m file where you intend to use the framework add

@import MobileConnectSDK;

Swift

In the .swift file you intend to use the framework just add

import MobileConnectSDK;

Before being able to use the library in code you'll have to provide the main developer information in your code (Redirect URI, Integration endpoint [aka application endpoint], Integration key [aka client key], Integration secret: [aka client secret] ) like below:

[MobileConnectSDK setClientKey:kClientKey];
[MobileConnectSDK setClientSecret:kClientSecret];
[MobileConnectSDK setApplicationEndpoint:kApplicationEndpoint];
[MobileConnectSDK setRedirect:[NSURL URLWithString:kRedirectURL]];

And that's it!

Usage

In case you just want to get the token there are several ways:

• By providing a delegate which will receive the main MobileConnectSDK events and dropping a button in the storyboards where you intend to use it

1. Make sure the delegate conforms to protocol MobileConnectManagerDelegate

@interface ViewController ()<MobileConnectManagerDelegate>

2. Implement the MobileConnectManagerDelegate in that class

- (void)mobileConnectWillStart;
- (void)mobileConnectWillPresentWebController;
- (void)mobileConnectWillDismissWebController;
- (void)mobileConnectDidGetTokenResponse:(TokenResponseModel * _Nonnull)tokenResponse;
- (void)mobileConnectFailedGettingTokenResponseWithError:(NSError * _Nonnull)error;

3. Drag and drop a view in your storyboards and set it's class to MobileConnectManagerButton

You'll receive the token response or the error in the above specified delegate methods.

• By using MobileConnectManager

1. Create the MobileConnectManager instance

MobileConnectManager *manager = [MobileConnectManager new];

2. Call one of the below methods.

If you don't have the client's phone number then just call the below method in which you have to provide a controller from which the framework will be able to present it's own web controller.

[manager getTokenInPresenterController:<theControllerFromWhichYouWishtToLaunchMobileConnectInsertHere> withCompletitionHandler:^(TokenResponseModel * _Nullable tokenResponseModel, NSError * _Nullable error) {
        
}];

If you have the client's phone number just provide it as a parameter as shown in the code below. But you'll still have to provide a controller which the framework will use for presenting it's own web controller.

[manager getTokenForPhoneNumber:@"<clientPhoneNumberInsertHere>" inPresenterController:self withCompletitionHandler:^(TokenResponseModel * _Nullable tokenResponseModel, NSError * _Nullable error) {
        
}];

In case you need to specifically use the Discovery service:

Create an instance of the DiscoveryService or DSService in Objective C code and use on of the the below methods.

DSService *discovery = [DSService new];

If you don't have client's phone number:

Don't forget to dismiss the controller which you receive in the callback method otherwise the web view will remain on the screen.

[discovery startOperatorDiscoveryInController:<theControllerFromWhichYouWishtToLaunchMobileConnectInsertHere> completitionHandler:^(BaseWebController * _Nullable controller, DiscoveryResponse * _Nullable operatorsData, NSError * _Nullable error) {
        
}];

If you have client's phone number:

You don't need to offer a view controller because there is no need for a web page to be displayed to the client. And you can call the following method:

[discovery startOperatorDiscoveryForPhoneNumber:@"<clientPhoneNumberInsertHere>" completitionHandler:^(DiscoveryResponse * _Nullable operatorsData, NSError * _Nullable error) {
        
}];

If you have the mobile operators country code and network code:

[discovery startOperatorDiscoveryWithCountryCode:@"<insertCountryCodeHere>" networkCode:@"<insertNetworkCodeHere>" completitionHandler:^(DiscoveryResponse * _Nullable operatorsData, NSError * _Nullable error) {
        
}];

In case you need to specifically use the Mobile Connect service:

Create an instance of the MobileConnectService or MCService in Objective C. You'll have to provide the operator data which you would tipically get from the DiscoveryService class

MCService *mobileConnectService = [[MCService alloc] initWithClientId:@"<clientIdFromDiscoveryServiceGoesHere>" authorizationURL:@"<authorizationURLFromDiscoveryGoesHere>" tokenURL:@"<tokenURLFromDiscoveryGoesHere>"];

After creating the MobileConnect or MCService instance you can get the token by providing a subcriberId if you have it from the Discovery stage or just provide nil for subscriber id. You'll also have to offer a view controller which will be used by the framework to present the web view. Don't forget to dismiss the controller which you receive in the callback method otherwise the web view will remain on the screen.

[mobileConnectService getTokenInController:self subscriberId:@"<inCaseYouReceivedASubscriberIDFromDiscoveryIfNotLeaveNil>" completitionHandler:^(BaseWebController * _Nullable controller, TokenModel * _Nullable tokenModel, NSError * _Nullable error) {
        
}];