NBUser

@interface NBUser : NSObject

ユーザクラス

  • ユーザID

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *userId;

    Swift

    var userId: String? { get }

  • ユーザネーム

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable) NSString *username;

    Swift

    var username: String? { get set }

  • Emailアドレス

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable) NSString *email;

    Swift

    var email: String? { get set }

  • ユーザ情報作成時刻

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSDate *created;

    Swift

    var created: Date? { get }

  • ユーザ情報更新時刻

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSDate *updated;

    Swift

    var updated: Date? { get }

  • ユーザのサインアップを行う。

    Declaration

    Objective-C

    - (void)signUpInBackgroundWithPassword:(nonnull NSString *)password
                                 block:(nonnull NBUserBlock)block;

    Swift

    func signUpInBackground(password: String, completion block: @escaping NBUserBlock)

    Parameters

    password

    サインアップするユーザのパスワード
    block

    実行結果を受け取るブロック

  • ユーザのログインを行う。

    Declaration

    Objective-C

    + (void)logInInBackgroundWithUsername:(nullable NSString *)username
                                email:(nullable NSString *)email
                             password:(nonnull NSString *)password
                                block:(nonnull NBUserBlock)block;

    Swift

    class func logInInBackground(username: String?, email: String?, password: String, completion block: @escaping NBUserBlock)

    Parameters

    username

    ログインするユーザのユーザネーム
    email

    ログインするユーザのEmailアドレス
    password

    ログインするユーザのパスワード
    block

    実行結果を受け取るブロック

  • ログアウトを行う。

    Declaration

    Objective-C

    + (void)logOutInBackgroundWithBlock:(nonnull NBUserBlock)block;

    Swift

    class func logOutInBackground(completion block: @escaping NBUserBlock)

    Parameters

    block

    実行結果を受け取るブロック

  • パスワードのリセット要求を行う。

    Declaration

    Objective-C

    + (void)resetPasswordInBackgroundWithUsername:(nullable NSString *)username
                                        email:(nullable NSString *)email
                                        block:(nonnull NBResultBlock)block;

    Swift

    class func resetPasswordInBackground(username: String?, email: String?, completion block: @escaping NBResultBlock)

    Parameters

    username

    リセット対象のユーザネーム
    email

    リセット対象のEmailアドレス
    block

    実行結果を受け取るブロック

  • ユーザ情報の変更を行う。

    Declaration

    Objective-C

    - (void)saveInBackgroundWithPassword:(nonnull NSString *)password
                               block:(nonnull NBUserBlock)block;

    Swift

    func saveInBackground(password: String, completion block: @escaping NBUserBlock)

    Parameters

    password

    変更するユーザのパスワード
    block

    実行結果を受け取るブロック

  • ユーザの削除を行う。

    Declaration

    Objective-C

    - (void)deleteInBackgroundWithBlock:(nonnull NBResultBlock)block;

    Swift

    func deleteInBackground(completion block: @escaping NBResultBlock)

    Parameters

    block

    実行結果を受け取るブロック

  • ユーザ情報の検索を行う。

    Declaration

    Objective-C

    + (void)queryUserInBackgroundWithUsername:(nullable NSString *)username
                                    email:(nullable NSString *)email
                                    block:(nonnull NBUsersBlock)block;

    Swift

    class func queryInBackground(username: String?, email: String?, completion block: @escaping NBUsersBlock)

    Parameters

    username

    検索対象のユーザネーム
    email

    検索対象のEmailアドレス
    block

    実行結果を受け取るブロック

  • ユーザ情報の取得を行う。

    Declaration

    Objective-C

    + (void)getUserInBackgroundWithUserId:(nonnull NSString *)userId
                                block:(nonnull NBUserBlock)block;

    Swift

    class func getInBackground(userId: String, completion block: @escaping NBUserBlock)

    Parameters

    userId

    検索対象のユーザID
    block

    実行結果を受け取るブロック

  • 現在ログインしているユーザの情報を取得する。

    Declaration

    Objective-C

    + (void)refreshCurrentUserInBackgroundWithBlock:(nonnull NBUserBlock)block;

    Swift

    class func refreshCurrentUserInBackground(completion block: @escaping NBUserBlock)

    Parameters

    block

    実行結果を受け取るブロック

  • 現在ログインしているユーザの情報をキャッシュから取得する(通信を行わない)。

    Declaration

    Objective-C

    + (nullable NBUser *)currentUser;

    Swift

    class func current() -> NBUser?

    Return Value

    ログイン中ユーザのユーザ情報

  • ログイン状態の確認を行う。

    Declaration

    Objective-C

    + (BOOL)loggedIn;

    Swift

    class func loggedIn() -> Bool

    Return Value

    ログイン中であればYES、未ログインであればNO

  • セッショントークンを取得する。

    Declaration

    Objective-C

    + (nullable NSString *)sessionToken;

    Swift

    class func sessionToken() -> String?

    Return Value

    セッショントークン

  • セッショントークンの有効期限を取得する。

    Declaration

    Objective-C

    + (long long)sessionTokenExpiration;

    Swift

    class func sessionTokenExpiration() -> Int64

    Return Value

    セッショントークンの有効期限