IF_FirebaseFollowHelper

public class IF_FirebaseFollowHelper

Firebaseにフォロー/フォロワー管理機能を追加すヘルパークラス

主な特徴は次の通りです。
1. Firebaseのデータ構造を意識せずに、フォロー関連の機能を利用できます
2. 他ユーザがログインユーザに関わる操作を行った場合、リアルタイムに通知を受け取る事ができます

Important

イベントはリアルタイムにNSNotificationCenterから通知されます。
通知は１つのイベントにつき１回のみです。
すべての通知を受け取りたい場合は初回インスタンス生成以降、常にいずれかのインスタンスにオブザーバを設定してください。

  • 共有インスタンス
    こちらからIF_FirebaseFollowHelperの各機能をコールしてください。

    Declaration

    Swift

    public static let sharedHelper = IF_FirebaseFollowHelper()

  • error domain

    Declaration

    Swift

    public static let errorDomain		= "IF_FirebaseFollowHelper"

  • error code

    See more

    Declaration

    Swift

    public enum errorCode: Int

  • デバッグ情報出力設定

    Declaration

    Swift

    public static var outputDebug = true

  • ログインユーザがフォローしているユーザ一覧を取得します

    Closureでは取得したユーザのuidと登録日時の一覧を使用できます。

    Declaration

    Swift

    public func getFollowList(completion: (([IF_FirebaseFollowHelperBasicUserInfo]) -> Void)?)

    Parameters

    completion

    取得完了時に実行するClosure

  • ログインユーザをフォローしているユーザ一覧を取得します

    Closureでは取得したユーザのuidと登録日時の一覧を使用できます。

    Declaration

    Swift

    public func getFollowerList(completion: (([IF_FirebaseFollowHelperBasicUserInfo]) -> Void)?)

    Parameters

    completion

    取得完了時に実行するClosure

  • ログインユーザがブロックしているユーザ一覧を取得します

    Closureでは取得したユーザのuidと登録日時の一覧を使用できます。

    Declaration

    Swift

    public func getBlockList(completion: (([IF_FirebaseFollowHelperBasicUserInfo]) -> Void)?)

    Parameters

    completion

    取得完了時に実行するClosure

  • ログインユーザをブロックしているユーザ一覧を取得します

    Closureでは取得したユーザのuidと登録日時の一覧を使用できます。

    Declaration

    Swift

    public func getBlockerList(completion: (([IF_FirebaseFollowHelperBasicUserInfo]) -> Void)?)

    Parameters

    completion

    取得完了時に実行するClosure

  • 対象ユーザをフォローします

    フォローに成功した場合、IF_FirebaseFollowHelperMessage.AddedFollowが通知されます。
    フォローに失敗した場合、IF_FirebaseFollowHelperMessage.FailedFollowが通知されます。
    すでにフォロー済みかフォローに失敗した場合、何も通知されません。
    処理完了時に、IF_FirebaseFollowHelperMessage.DidAddFollowProcが通知されます。

    Declaration

    Swift

    public func follow(userID: String)

    Parameters

    userID

    対象ユーザのuid

  • 対象ユーザ（複数）をフォローします

    フォローに成功した場合、IF_FirebaseFollowHelperMessage.AddedFollowが通知されます。
    フォローに失敗した場合、IF_FirebaseFollowHelperMessage.FailedFollowが通知されます。
    すでにフォロー済みかフォローに失敗した場合、何も通知されません。
    処理完了時に、IF_FirebaseFollowHelperMessage.DidAddFollowProcが通知されます。

    Declaration

    Swift

    public func follow(userIDs: [String])

    Parameters

    userIDs

    対象ユーザのuid一覧

  • 対象ユーザのフォローを解除します

    フォロー解除に成功した場合、IF_FirebaseFollowHelperMessage.RemovedFollowが通知されます。 フォロー解除に失敗した場合、IF_FirebaseFollowHelperMessage.FailedRemoveFollowが通知されます。
    フォローしていないユーザをフォロー解除した場合かフォロー解除に失敗した場合、何も通知されません。
    処理完了時にIF_FirebaseFollowHelperMessage.DidRemoveFollowProcが通知されます。

    Declaration

    Swift

    public func unFollow(userID: String)

    Parameters

    userID

    対象ユーザのuid

  • 対象ユーザ（複数）のフォローを解除します

    フォロー解除に成功した場合、IF_FirebaseFollowHelperMessage.RemovedFollowが通知されます。
    フォロー解除に失敗した場合、IF_FirebaseFollowHelperMessage.FailedRemoveFollowが通知されます。
    フォローしていないユーザをフォロー解除した場合かフォロー解除に失敗した場合、何も通知されません。
    処理完了時にIF_FirebaseFollowHelperMessage.DidRemoveFollowProcが通知されます。

    Declaration

    Swift

    public func unFollow(userIDs: [String])

    Parameters

    userIDs

    対象ユーザのuid一覧

  • 対象ユーザをブロックします

    ブロックに成功した場合、IF_FirebaseFollowHelperMessage.AddedBlockが通知されます。
    ブロックに失敗した場合、IF_FirebaseFollowHelperMessage.FailedBlockが通知されます。
    すでにブロック済みのuidを指定した場合、何も通知されません。
    処理完了時に、DIF_FirebaseFollowHelperMessage.idAddBlockProcが通知されます。

    Declaration

    Swift

    public func block(userID: String)

    Parameters

    userID

    対象ユーザのuid

  • 対象ユーザ（複数）をブロックします

    ブロックに成功した場合、IF_FirebaseFollowHelperMessage.AddedBlockが通知されます。
    ブロックに失敗した場合、IF_FirebaseFollowHelperMessage.FailedBlockが通知されます。
    すでにブロック済みのuidを指定した場合、何も通知されません。
    処理完了時に、DIF_FirebaseFollowHelperMessage.DidAddBlockProcが通知されます。

    Declaration

    Swift

    public func block(userIDs: [String])

    Parameters

    userIDs

    対象ユーザのuid一覧

  • 対象ユーザのブロックを解除します

    ブロックの解除に成功した場合、IF_FirebaseFollowHelperMessage.RemovedBlockが通知されます。
    ブロックの解除に失敗した場合、IF_FirebaseFollowHelperMessage.FailedRemoveBlockが通知されます。
    ブロックしていないユーザをブロック解除した場合、何も通知されません。
    処理完了時に、IF_FirebaseFollowHelperMessage.DidRemoveBlockProcが通知されます。

    Declaration

    Swift

    public func unBlock(userID: String)

    Parameters

    userID

    対象ユーザのuid一覧

  • 対象ユーザ（複数）のブロックを解除します

    ブロックの解除に成功した場合、IF_FirebaseFollowHelperMessage.RemovedBlockが通知されます。
    ブロックの解除に失敗した場合、IF_FirebaseFollowHelperMessage.FailedRemoveBlockが通知されます。
    ブロックしていないユーザをブロック解除した場合、何も通知されません。
    処理完了時に、IF_FirebaseFollowHelperMessage.DidRemoveBlockProcが通知されます。

    Declaration

    Swift

    public func unBlock(userIDs: [String])

    Parameters

    userIDs

    対象ユーザのuid一覧