NCMBUser

public class NCMBUser : NCMBBase

会員情報を操作するためのクラスです。

  • イニシャライズです。

    Declaration

    Swift

    public init()
  • ログインユーザーのセッショントークンです。

    Declaration

    Swift

    public class var currentUserSessionToken: String? { get }
  • セッショントークンです。

    Declaration

    Swift

    public var sessionToken: String? { get }
  • ユーザー名です。

    Declaration

    Swift

    public var userName: String? { get set }
  • パスワードです。

    Declaration

    Swift

    public var password: String? { get set }
  • メールアドレスです。

    Declaration

    Swift

    public var mailAddress: String? { get set }
  • 会員情報を検索するためのクエリです。

    Declaration

    Swift

    public class var query: NCMBQuery<NCMBUser> { get }
  • ログインユーザー情報を返します。

    Declaration

    Swift

    public class var currentUser: NCMBUser? { get }
  • ユーザが認証済みかを表します。 認証済みの場合は true 、それ以外では false

    Declaration

    Swift

    public var isAuthenticated: Bool { get }
  • anonymous認証による自動会員登録を同期処理にて実行します。

    Declaration

    Swift

    public class func automaticCurrentUser() -> NCMBResult<NCMBUser>

    Return Value

    リクエストが成功した場合は .success<NCMBUser> 、 失敗した場合は .failure<Error>

  • anonymous認証による自動会員登録を非同期処理にて実行します。

    Declaration

    Swift

    public class func automaticCurrentUserInBackground(callback: @escaping NCMBHandler<NCMBUser>) -> Void

    Parameters

    callback

    レスポンス取得後に実行されるコールバックです。

  • 匿名ユーザの自動生成を有効化します。

    Declaration

    Swift

    public class func enableAutomaticUser()
  • 匿名ユーザの自動生成を無効化します。

    Declaration

    Swift

    public class func disableAutomaticUser()
  • 設定された内容から会員情報を同期処理にて登録します。

    Declaration

    Swift

    public func signUp() -> NCMBResult<Void>

    Return Value

    リクエストが成功した場合は .success 、 失敗した場合は .failure<Error>

  • 設定された内容から会員情報を非同期処理にて登録します。

    Declaration

    Swift

    public func signUpInBackground(callback: @escaping NCMBHandler<Void>) -> Void

    Parameters

    callback

    レスポンス取得後に実行されるコールバックです。

  • 指定メールアドレスに対して、会員登録を行うためのメールを送信します。

    Declaration

    Swift

    public class func requestAuthenticationMail(mailAddress: String) -> NCMBResult<Void>

    Parameters

    mailAddress

    メールアドレス

    Return Value

    リクエストが成功した場合は .success 、 失敗した場合は .failure<Error>

  • 指定メールアドレスに対して、会員登録を行うためのメールを送信します。

    Declaration

    Swift

    public class func requestAuthenticationMailInBackground(mailAddress: String, callback: @escaping NCMBHandler<Void>) -> Void

    Parameters

    mailAddress

    メールアドレス

    callback

    レスポンス取得後に実行されるコールバックです。

  • ログインを同期処理にて行います。

    Declaration

    Swift

    public class func logIn(userName: String, password: String) -> NCMBResult<Void>

    Parameters

    userName

    ユーザー名

    password

    パスワード

    Return Value

    リクエストが成功した場合は .success 、 失敗した場合は .failure<Error>

  • ログインを非同期処理にて行います。

    Declaration

    Swift

    public class func logInInBackground(userName: String, password: String, callback: @escaping NCMBHandler<Void>) -> Void

    Parameters

    userName

    ユーザー名

    password

    パスワード

    callback

    レスポンス取得後に実行されるコールバックです。

  • ログインを同期処理にて行います。

    Declaration

    Swift

    public class func logIn(mailAddress: String, password: String) -> NCMBResult<Void>

    Parameters

    mailAddress

    メールアドレス

    password

    パスワード

    Return Value

    リクエストが成功した場合は .success 、 失敗した場合は .failure<Error>

  • ログインを非同期処理にて行います。

    Declaration

    Swift

    public class func logInInBackground(mailAddress: String, password: String, callback: @escaping NCMBHandler<Void>) -> Void

    Parameters

    mailAddress

    メールアドレス

    password

    パスワード

    callback

    レスポンス取得後に実行されるコールバックです。

  • ログアウトを同期処理にて行います。

    Declaration

    Swift

    public class func logOut() -> NCMBResult<Void>

    Return Value

    リクエストが成功した場合は .success 、 失敗した場合は .failure<Error>

  • ログアウトを非同期処理にて行います。

    Declaration

    Swift

    public class func logOutInBackground(callback: @escaping NCMBHandler<Void>) -> Void

    Parameters

    callback

    レスポンス取得後に実行されるコールバックです。

  • 指定メールアドレスに該当する会員に対して、パスワード再発行を行うためのメールを送信するためのリクエストを同期処理にて行います。

    Declaration

    Swift

    public class func requestPasswordReset(mailAddress: String) -> NCMBResult<Void>

    Parameters

    mailAddress

    メールアドレス

    Return Value

    リクエストが成功した場合は .success 、 失敗した場合は .failure<Error>

  • 指定メールアドレスに該当する会員に対して、パスワード再発行を行うためのメールを送信するためのリクエストを非同期処理にて行います。

    Declaration

    Swift

    public class func requestPasswordResetInBackground(mailAddress: String, callback: @escaping NCMBHandler<Void>) -> Void

    Parameters

    mailAddress

    メールアドレス

    callback

    レスポンス取得後に実行されるコールバックです。

  • 設定されたオブジェクトIDに対応する会員情報を非同期処理にて取得します。

    Declaration

    Swift

    public func fetchInBackground(callback: @escaping NCMBHandler<Void> ) -> Void

    Parameters

    callback

    レスポンス取得後に実行されるコールバックです。

  • 会員情報を同期処理にて保存します。

    Declaration

    Swift

    public func save() -> NCMBResult<Void>

    Return Value

    リクエストが成功した場合は .success 、 失敗した場合は .failure<Error>

  • 会員情報を非同期処理にて保存します。

    Declaration

    Swift

    public func saveInBackground(callback: @escaping NCMBHandler<Void> ) -> Void

    Parameters

    callback

    レスポンス取得後に実行されるコールバックです。

  • 設定されたオブジェクトIDに対応する会員情報を同期処理にて削除します。

    Declaration

    Swift

    public func delete() -> NCMBResult<Void>

    Return Value

    リクエストが成功した場合は .success 、 失敗した場合は .failure<Error>

  • 設定されたオブジェクトIDに対応する会員情報を非同期処理にて削除します。

    Declaration

    Swift

    public func deleteInBackground(callback: @escaping NCMBHandler<Void> ) -> Void

    Parameters

    callback

    レスポンス取得後に実行されるコールバックです。