IF_FirebaseFollowHelperKit Reference
IF_FirebaseFollowHelperKit
Firebaseにユーザフォロー機能を追加します。
ドキュメントはこちらです。
新しいFirebase SDK(3.2.0)に対応しました
Features
- Firebaseのデータ構造を意識せずに、フォロー関連の機能を利用できます。
- 他ユーザがログインユーザに関わる操作を行った場合、リアルタイムに通知を受け取る事ができます。
- 単純なArrayで処理結果が返されるので、filterなどの加工処理が容易です。
How to use
前提条件
IF_FirebaseFollowHelperKitはFirebaseに機能を追加するため、Firebaseが動作している事が前提条件となります。
またユーザ識別に認証情報を利用するため、認証済みのFirebaseインスタンスを利用する必要があります。
初期化
初期化は必要ありません。
ヘルパーのシングルトンインスタンスにアクセスしてください。
let followHelper = IF_FirebaseFollowHelper.sharedHelper
ユーザをフォローする
let uid = 対象ユーザのuid
followHelper.follow(uid)
ユーザのフォローを解除する
let uid = 対象ユーザのuid
followHelper.unFollow(uid)
認証ユーザがフォローしているユーザのリストを得る
followHelper.getFollowList() { followList in
print(followList)
}
認証ユーザをフォローしているユーザのリストを得る
followHelper.getFollowerList() { followerList in
print(followerList)
}
ユーザをブロックする
let uid = 対象ユーザのuid
followHelper.block(uid)
ユーザのブロックを解除する
let uid = 対象ユーザのuid
followHelper.unBlock(uid)
認証ユーザがブロックしているユーザのリストを得る
followHelper.getBlockList() { blockList in
print(blockList)
}
認証ユーザをブロックしているユーザのリストを得る
followHelper.getBlockerList() { blockerList in
print(blockerList)
}
イベントを受信する
例えばどこか別の場所であるユーザが認証ユーザをフォローした時など、リアルタイムにヘルパーからメッセージが発行されます。
メッセージは NSNotificationCenter.defaultCenter() を介して通知されるので、受信したい場所にオブザーバを登録してください。
発行されるメッセージはこちらをご覧下さい。
例）他のユーザが認証ユーザをフォローした際に通知される AddedFollower メッセージを受け取ります
override func viewDidLoad() {
super.viewDidLoad()
NSNotificationCenter.defaultCenter().addObserver(self, selector: #selector(ViewController.handleNotification(_:)), name: nil, object: nil)
}
func handleNotification(notification: NSNotification) {
if notification.name == IF_FirebaseFollowHelperMessage.AddedFollower {
if let uid = userInfo["uid"] as? String, let timestamp = userInfo["timestamp"] as? NSDate {
print("[\(uid)] followed you. \(timestamp)")
}
}
}
Runtime Requirements
Firebase/Core
Firebase/Auth
Firebase/Database
Installation and Setup
プロジェクトに IF_FirebaseFollowHelper.swift を追加してください。
Demo Setup
デモを確認する場合、次の手順を実施してください。
1. Demoディレクトリで pod install を実行し、Firebaseを環境に追加します。
2. 作成された Demo.xcworkspace を開き、実行します。
※ 共有目的のFirebaseDBを設定していますので、節度を持ってご利用ください。
Cocoapods
Cocoapodsからのインストールに対応しています。
下記のようにPodfileを作成し、 pod install を実行してください。
※ Firebaseもインストールされます。
※ 旧FirebaseSDK対応版はバージョン 0.0.1 です。
use_frameworks!
target ‘プロジェクト名’ do
pod ‘IF_FirebaseFollowHelperKit’
end
Document
http://ict-fractal.com/OSSDoc/IF_FirebaseFollowHelperKit/index.html