<commit_before>#LinkedME iOS 集成文档

[![CI Status](http://img.shields.io/travis/Bindx/LinkedME_iOS.svg?style=flat)](https://travis-ci.org/Bindx/LinkedME_iOS)
[![Version](https://img.shields.io/cocoapods/v/LinkedME_iOS.svg?style=flat)](http://cocoapods.org/pods/LinkedME_iOS)
[![License](https://img.shields.io/cocoapods/l/LinkedME_iOS.svg?style=flat)](http://cocoapods.org/pods/LinkedME_iOS)
[![Platform](https://img.shields.io/cocoapods/p/LinkedME_iOS.svg?style=flat)](http://cocoapods.org/pods/LinkedME_iOS)

## Installation

LinkedME_iOS is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:

```ruby
pod "LinkedME_iOS"
```
## Example

To run the example project, clone the repo, and run `pod install` from the Example directory first.

# 1.下载SDK&Demo（简述）
![sdkinfo set up](http://7xq8b0.com1.z0.glb.clouddn.com/sdk_info.png)

文件名 | 描述
------------ | -------------
LinkedME_iOS.framework | LinkedME SDK
DetailViewController | Demo详情页-webView加载html网页 
DemoViewController | 生成短链，展示生成锻炼的必要参数 
DefaultData | 参数默认必要参数 

注：为了iOS/Android/Web三端更好的统一，和版本迭代更新

## 1.1. Framework
	1.CoreSpotlight.framework (status:Optional)
	2.SystemConfiguration.framework
	3.Security.framework
	
	注:CoreSpotlight.framework必须标记为可选
	
![spotlight warning](http://7xq8b0.com1.z0.glb.clouddn.com/spotlight1.png)

# 2.注册用户
1. 注册用户，并登陆系统

![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/register1.png)

# 3.创建App生成linkedme_key
1. 创建app

	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/create_app11.png)
	
	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/create_app22.png)

2. 获取LinkedME Key

	创建完App后，系统会分配一个LinkedME App ID、LinkedME Key和LinkedME Secret（无法修改）。
	
	如下图的红框2，就是LinkedME Key。

	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/get_key.png)


3. 设置App，分为两部分：概览和链接；其中概览部分只能修改app名称和修改LOGO。


4. 设置App的链接部分

	4.1 如果没有iOS应用，Directed URL框里填写深度链接默认跳转地址；
	
	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/set_app_ios1.png)
	
	4.2 如果有iOS应用，勾选有iOS应用的框，并填写App的URI Scheme；如果App在App Store上线了，请勾选“App Store”，并填写App在App Store上的地址；
	
	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/set_app_ios2.png)
	
	4.3 如果App没有在App Store上线，请勾选“自定义”，并填写App的ipc文件的下载地址；
	
	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/set_app_ios3.png)
	
	4.4 如果App支持Universal Links，请勾选“Universal Links”,并填写Bundle ID和Apple App Prefix。
	
	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/set_app_ios4.png)

# 4.工程设置
## 4.1 注册URLScheme（推荐/可选）
	1.打开info.plist
	2.找到URL Types（如果没有就右键add row添加一个）
	3.添加"you app"(你的app的唯一标识字符串)
![URL Scheme](https://www.linkedme.cc/docs/images/4.1.5.jpg)


	
	
## 4.2 Universal Linking (仅支持iOS 9)
	1.在左侧导航器中点击您的项目
	2.选择'Capabilities'标签
	3.打开'Associated Domains'开关
	4.添加applinks:lkme.cc和applinks:www\.lkme\.cc
![Associated Domains set up](https://www.linkedme.cc/docs/images/4.1.6.jpg)


# 5.代码集成

## 5.1 添加linkedme_key
	1.打开info.plist文件
	2.在列表中点击右键选择add row添加一个分组
	3.创建一个新的item名称为linkedme_key类型为Dictionary。
	4.在linkedme_key新增两个字符串类型的item分别为live和test

![lmkey set up](https://www.linkedme.cc/docs/images/4.1.7.jpg)

## 5.2 设置AppDelegate
### 5.2.1 解析深度链接跳转参数
### Objective-C

#####1.在AppDelegate中引入头文件 

#####　`#import <LinkedME_iOS/LinkedME.h>`

#####2.在Appdelegate里注册ViewController
####　2.1配置注册vc设置及跳转方式

```objc
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.'
    //初始化及实例
    LinkedME* linkedme = [LinkedME getInstance];
    
    //    //注册需要跳转的viewController
    UIStoryboard * storyBoard=[UIStoryboard storyboardWithName:@"Main" bundle:[NSBundle mainBundle]];
    DetailViewController  *dvc=[storyBoard instantiateViewControllerWithIdentifier:@"detailView"];
    
    //如果使用自动跳转需要注册viewController
    //    [linkedme registerDeepLinkController:featureVC forKey:@"LMFeatureViewController"];<commit_msg>修改图片地址<commit_after>#LinkedME iOS 集成文档

[![CI Status](http://img.shields.io/travis/Bindx/LinkedME_iOS.svg?style=flat)](https://travis-ci.org/Bindx/LinkedME_iOS)
[![Version](https://img.shields.io/cocoapods/v/LinkedME_iOS.svg?style=flat)](http://cocoapods.org/pods/LinkedME_iOS)
[![License](https://img.shields.io/cocoapods/l/LinkedME_iOS.svg?style=flat)](http://cocoapods.org/pods/LinkedME_iOS)
[![Platform](https://img.shields.io/cocoapods/p/LinkedME_iOS.svg?style=flat)](http://cocoapods.org/pods/LinkedME_iOS)

## Installation

LinkedME_iOS is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:

```ruby
pod "LinkedME_iOS"
```
## Example

To run the example project, clone the repo, and run `pod install` from the Example directory first.

# 1.下载SDK&Demo（简述）
![sdkinfo set up](http://7xq8b0.com1.z0.glb.clouddn.com/sdk_info.png)

文件名 | 描述
------------ | -------------
LinkedME_iOS.framework | LinkedME SDK
DetailViewController | Demo详情页-webView加载html网页 
DemoViewController | 生成短链，展示生成锻炼的必要参数 
DefaultData | 参数默认必要参数 

注：为了iOS/Android/Web三端更好的统一，和版本迭代更新

## 1.1. Framework
	1.CoreSpotlight.framework (status:Optional)
	2.SystemConfiguration.framework
	3.Security.framework
	
	注:CoreSpotlight.framework必须标记为可选
	
![spotlight warning](http://7xq8b0.com1.z0.glb.clouddn.com/spotlight1.png)

# 2.注册用户
1. 注册用户，并登陆系统

![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/register1.png)

# 3.创建App生成linkedme_key
1. 创建app

	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/create_app11.png)
	
	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/create_app22.png)

2. 获取LinkedME Key

	创建完App后，系统会分配一个LinkedME App ID、LinkedME Key和LinkedME Secret（无法修改）。
	
	如下图的红框2，就是LinkedME Key。

	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/get_key.png)


3. 设置App，分为两部分：概览和链接；其中概览部分只能修改app名称和修改LOGO。


4. 设置App的链接部分

	4.1 如果没有iOS应用，Directed URL框里填写深度链接默认跳转地址；
	
	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/set_app_ios1.png)
	
	4.2 如果有iOS应用，勾选有iOS应用的框，并填写App的URI Scheme；如果App在App Store上线了，请勾选“App Store”，并填写App在App Store上的地址；
	
	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/set_app_ios2.png)
	
	4.3 如果App没有在App Store上线，请勾选“自定义”，并填写App的ipc文件的下载地址；
	
	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/set_app_ios3.png)
	
	4.4 如果App支持Universal Links，请勾选“Universal Links”,并填写Bundle ID和Apple App Prefix。
	
	![image](http://o8fx2z8ev.bkt.clouddn.com/lkme/set_app_ios4.png)

# 4.工程设置
## 4.1 注册URLScheme（推荐/可选）
	1.打开info.plist
	2.找到URL Types（如果没有就右键add row添加一个）
	3.添加"you app"(你的app的唯一标识字符串)
![URL Scheme](http://7xq8b0.com1.z0.glb.clouddn.com/1.jpg)


	
	
## 4.2 Universal Linking (仅支持iOS 9)
	1.在左侧导航器中点击您的项目
	2.选择'Capabilities'标签
	3.打开'Associated Domains'开关
	4.添加applinks:lkme.cc和applinks:www\.lkme\.cc
![Associated Domains set up](http://7xq8b0.com1.z0.glb.clouddn.com/2.jpg)


# 5.代码集成

## 5.1 添加linkedme_key
	1.打开info.plist文件
	2.在列表中点击右键选择add row添加一个分组
	3.创建一个新的item名称为linkedme_key类型为Dictionary。
	4.在linkedme_key新增两个字符串类型的item分别为live和test

![lmkey set up](http://7xq8b0.com1.z0.glb.clouddn.com/3.jpg
)

## 5.2 设置AppDelegate
### 5.2.1 解析深度链接跳转参数
### Objective-C

#####1.在AppDelegate中引入头文件 

#####　`#import <LinkedME_iOS/LinkedME.h>`

#####2.在Appdelegate里注册ViewController
####　2.1配置注册vc设置及跳转方式

```objc
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.'
    //初始化及实例
    LinkedME* linkedme = [LinkedME getInstance];
    
    //    //注册需要跳转的viewController
    UIStoryboard * storyBoard=[UIStoryboard storyboardWithName:@"Main" bundle:[NSBundle mainBundle]];
    DetailViewController  *dvc=[storyBoard instantiateViewControllerWithIdentifier:@"detailView"];
    
    //如果使用自动跳转需要注册viewController
    //    [linkedme registerDeepLinkController:featureVC forKey:@"LMFeatureViewController"];
{'fraction_non_alphanumeric': 0.1510782021304235, 'fraction_numerical': 0.028189140036373083, 'mean_word_length': 5.095803642121932, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 11, 'lorem ipsum': 0, 'www.': 5, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6357302', 'n_tokens_mistral': 3867, 'n_tokens_neox': 3845, 'n_words': 387}