WordPressCom-Stats-iOS
简介
WordPressCom-Stats-iOS 是 WordPress iOS 应用中用于显示托管在 WordPress.com 上的站点的统计信息的可重用组件。您可以在自己的应用程序中使用 UIViewController 子类,或者使用其中的服务来获取自己的统计数据。
入门指南
您可以通过 CocoaPods 在您的应用程序中安装统计组件
platform :ios, '10.0'
pod 'WordPressCom-Stats-iOS'
或者,您可以通过使用 CocoaPods try 命令来尝试试样例
pod try WordPressCom-Stats-iOS
需求
WordPressCom-Stats-iOS需要iOS 7.0或更高版本和ARC。它依赖于以下Apple框架
- Foundation.framework
- UIKit.framework
- CoreGraphics.framework
以及以下CocoaPods
- AFNetworking
- CocoaLumberjack
- NSObject+SafeExpectations
- WordPress-iOS-Shared
- WordPressCom-Analytics-iOS
有关更多信息,请参阅podspec。
使用方法
要在您的应用程序中使用WordPressCom-Stats-iOS,您需要完成以下三件事。
-
创建一个继承自
WPStatsViewController
的UIViewController子类。(可选地,您可以选择使用组合,让您的UIViewController包含一个WPStatsViewController的实例并将它添加为子视图。请参阅示例项目以获取示例。)#import <UIKit/UIKit.h> #import <WordPressCom-Stats-iOS/WPStatsViewController.h> @interface WPViewController : WPStatsViewController <WPStatsViewControllerDelegate> @end
-
从WordPress.com获取OAuth2令牌。目前,WordPress.com的认证机制不是可重用的库的一部分。您将需要手动通过以下方法获得(这些指示):https://developer.wordpress.com/docs/oauth2/。获取OAuth2令牌的最简单方法是,在生成令牌后在WordPress-iOS应用程序中设置一个断点。
-
获取您希望查看统计信息的网站/博客ID。
-
将网站ID和OAuth2令牌传递给初始化方法,或在从控制器显示视图之前将其作为参数设置。
有关更多信息,您可以查看本repo中包含的StatsDemo项目。
其他资源
开发者博客 & 指南
博客:http://make.wordpress.org/mobile
指南:http://make.wordpress.org/mobile/handbook/
风格指南
https://github.com/wordpress-mobile/WordPress-iOS/wiki/WordPress-for-iOS-Style-Guide
报告问题(仅限统计组件)
https://github.com/wordpress-mobile/WordPressCom-Stats-iOS/issues?state=open
源代码
GitHub: https://github.com/wordpress-mobile/WordPressCom-Stats-iOS/
如何贡献
http://make.wordpress.org/mobile/handbook/pathways/ios/how-to-contribute/
未来增强功能
- 将网络栈替换为 WordPressComApi 公共库
许可协议
WordPressCom-Stats-iOS 在 MIT 许可协议下可用。有关更多信息,请参阅 LICENSE 文件。