• UIKit
  • SDK
  • サーバー API
Chat/
SDK/
Flutter/
ログインとログアウト/
SDK
  • Chat SDK のインストール
    • インストール
  • Chat SDK の初期化
    • 初期化
  • ログインとログアウト
    • ログインとログアウト
  • メッセージ
    • メッセージの概要
    • メッセージ送信
    • メッセージの受信
    • 過去のメッセージ
    • メッセージ転送
    • メッセージの変更
    • メッセージ挿入
    • メッセージ削除
    • メッセージをクリア
    • メッセージの取り消し
    • オンラインメッセージ
    • 既読レシート
    • クエリーメッセージ
    • グループ @ メッセージ
    • ターゲットグループメッセージ
    • 通知のサイレントモード
    • メッセージ拡張
  • セッション
    • セッションの概要
    • セッションリスト
    • セッションの取得
    • 未読セッション数
    • セッションの先頭固定表示
    • セッションの削除
    • セッションの下書き
    • セッショングループ
  • グループ
    • グループの概要
    • グループ管理
    • グループプロファイル
    • グループメンバーの管理
    • グループメンバープロファイル
    • グループプロパティのカスタマイズ
  • ユーザー
    • ユーザープロファイル
    • 友達管理
    • 友達リスト
    • ブラックリスト
  • オフラインプッシュ
    • オフラインプッシュ
  • シグナリング
    • シグナリング管理
  • ローカル検索
    • メッセージ検索
    • 友達を検索
    • グループの検索
    • グループメンバーの検索
  • インターフェースリファレンスドキュメンテーション
    • 顧客インターフェース
  • Guideline for Beginners
  • コンソールガイド
    • アプリケーションの作成とアップグレード
    • 基本設定
    • 機能設定
    • アカウント管理
    • グループ管理
    • コールバック設定
  • 製品紹介
    • メッセージ管理
      • シングルチャットメッセージ
      • メッセージの保存
      • オフラインプッシュ
      • グループメッセージ
      • メッセージフォーマット
    • アカウントシステム
      • ログイン認証
      • オンライン状態管理
    • グループ関連
      • グループシステム
      • グループ管理
    • ユーザープロファイルとリレーションシップチェーン
      • 資料管理
      • リレーションシップチェーン管理
  • 購入ガイド
    • 課金の概要
    • 価格
  • エラーコード

ログインとログアウト

機能説明

IM SDKを初期化した後、SDKログインインターフェースを呼び出して、アカウントのIDを確認し、アカウントの機能を使用する権限を取得する必要があります。メッセージ、セッションなどの機能は、IM SDKへのログインに成功して初めて正常に使用できます。
ご注意:
ログインインターフェースを呼び出した直後に、セッションを取得したインターフェースのみを呼び出すことができます。他の機能のインターフェースは、SDKへのログインに成功した後にのみ呼び出すことができます。したがって、他の機能を使用する前に、必ずログインし、ログインに成功したことを確認してください。そうでない場合、機能が異常または使用できない可能性があります。

ログイン

初めてIMアカウントにログインする場合、最初にアカウントを登録する必要はありません。ログインに成功すると、IMはこのアカウントの登録を自動的に完了します。 login(クリックして詳細を表示) インターフェースを呼び出して、ログインできます。
loginインターフェースのキーパラメータは次のとおりです:
パラメータ
意味
説明
UserID
ログインユーザーの固有識別
大文字と小文字の英字(a-z、A-Z)、数字(0-9)、アンダースコア(_)およびハイフン(-)のみを含めることをお勧めします。長さは32バイトを超えることはできません。
UserSig
ログインチケット
セキュリティのために業務サーバーによって計算されます。計算方法については、UserSig 后台 APIをご参照ください。
次のシナリオでは、loginインターフェースを呼び出す必要があります:
App起動後、初めてIM SDK機能を使用する場合。
ログイン時にチケットの有効期限が切れる場合:loginインターフェースのコールバックはERR_USER_SIG_EXPIRED(6206)またはERR_SVR_ACCOUNT_USERSIG_EXPIRED(70001)エラーコードが返されます。この場合は、新しいuserSigを生成し、再度ログインしてください。
オンライン時にチケットの有効期限が切れる場合:ユーザーがオンライン時にonUserSigExpired(クリックして詳細を表示)コールバックを受信することもできます。この場合は、新しいuserSigを生成し、再度ログインする必要があります。
オンライン時にオフラインでキックされる:ユーザーがオンライン中にキックされ、IM SDKはonKickedOffline(クリックして詳細を表示)コールバックを通じて通知します。この場合は、UIでユーザーにプロンプトを表示し、loginを呼び出して再度ログインすることができます。
次のシナリオでは、loginインターフェースを呼び出す必要はありません。
ユーザーのネットワークが切断され、再接続された後、login関数を呼び出す必要はなく、IM SDKは自動的にオンラインになります。
ログインプロセスが進行中の場合、繰り返しログインを実行する必要はありません。
説明:
1. IM SDKインターフェースを呼び出してログインに成功すると、DAUの計算が開始されます。過剰なDAUを避けるために、サービスケースに従って適切にログインインターフェースを呼び出してください。
2. Appでは、IM SDKは複数のアカウントが同時にオンラインになることをサポートしません。複数のアカウントが同時にログインした場合、最後にログインしたアカウントのみがオンラインになります。
サンプルコードは次のとおりです:
String userID = "your user id";
String userSig = "userSig from your server";
V2TimCallback res = await TencentImSDKPlugin.v2TIMManager.login(userID: userID, userSig: userSig);
if(res.code == 0){
// ログインに成功するロジック
}else{
// ログインに失敗するロジック
}

ログインユーザーの取得

ログインに成功すると、getLoginUser(クリックして詳細を表示)を呼び出して、ログインユーザーUserIDを取得します。 ログインに失敗する場合は、取得したログインユーザーUserIDは空になります。
サンプルコードは次のとおりです:
// ユーザーがログインに成功した後に呼び出すことができます
// getLoginUserを呼び出して、ログインに成功したユーザーUserIDを取得します
V2TimValueCallback<String> getLoginUserRes =
await TencentImSDKPlugin.v2TIMManager.getLoginUser();
if (getLoginUserRes.code == 0) {
//取得に成功
getLoginUserRes.data; // getLoginUserRes.dataはクエリーされたログインユーザーUserIDです
}

ログイン状態の取得

getLoginStatus(クリックして詳細を表示)を呼び出して、ログイン状態を取得します。ユーザーがすでにログインしているか、ログイン中の場合は、ログインインターフェースを頻繁に呼び出してログインしないでください。IM SDKでサポートされているログイン状態を次の表に示します。
ログイン状態
意味
V2TIM_STATUS_LOGINED (1)
ログインしている
V2TIM_STATUS_LOGINING (2)
ログイン中
V2TIM_STATUS_LOGOUT (3)
ログインしていない
サンプルコードは次のとおりです。
// ユーザーがログインに成功した後に呼び出すことができます
// getLoginStatusを呼び出して、ログインに成功したユーザー状態を取得します
V2TimValueCallback<int> getLoginStatusRes =
await TencentImSDKPlugin.v2TIMManager.getLoginStatus();
if (getLoginStatusRes.code == 0) {
int? status = getLoginStatusRes.data; // getLoginStatusRes.dataはユーザーのログイン状態の値です
if (status == 1) {
// ログインしている
} else if (status == 2) {
// ログイン中
} else if (status == 3) {
// ログインしていない
}
}

多端末ログインと相互キック

Tencent CloudコンソールでIM SDKの多端末ログインポリシーを設定することができます。 多端末ログイン戦略には、「モバイルまたはデスクトッププラットフォームで1つのプラットフォームをオンラインにすることができる + Webで同時にオンラインにすることができる」、「異なるプラットフォームを同時にオンラインにすることができる」など、多くのオプションがあります。 関連する構成については、ログイン設定をご参照ください。
Tencent Cloudコンソールで同じプラットフォームにログインできるIM SDKインスタンスの数を構成できます。つまり、同じプラットフォームのデバイスは同時に複数のオンラインをサポートできます。 この機能はUltimate Editionでのみ使用できます。現在、Web上で同時にオンラインにできる最大数は10です。Android、iPhone、iPad、Windows、Mac(Flutterは実際のコンパイル結果に依存します)プラットフォームで、同時にオンラインにできるデバイスの最大数は3です。 関連する構成については、ログイン設定をご参照ください。
login(クリックして詳細を表示)インターフェースを呼び出すとき、同じアカウントの多端末ログインポリシーが制限を超えた場合、新しくログインしたインスタンスは、以前にログインしたインスタンスをオフラインにします。 オフラインにキックされた側は、onKickedOffline(クリックして詳細を表示)コールバックを受信します。

ログアウト

通常の状況では、アプリケーションのライフサイクルがIM SDKのライフサイクルと一致している場合、アプリケーションを終了する前にログアウトする必要はなく、直接終了するだけで済みます。 ただし、一部の特別なシナリオ、たとえば、特定のインターフェースに入った後にのみIM SDKを使用し、インターフェースを終了した後は使用しなくなる場合では、logout(クリックして詳細を表示)インターフェースを呼び出して、SDKからログアウトすることができます。ログアウトに成功すると、他のユーザーからの新しいメッセージは受信されなくなります。この場合、ログアウトに成功した後、unInitSDK(クリックして詳細を表示)を呼び出して、SDKの未初期化を実行する必要があることに注意してください。
サンプルコードは次のとおりです:
V2TimCallback logoutRes = await TencentImSDKPlugin.v2TIMManager.logout();
if(logoutRes.code == 0){

}

アカウントの切り替え

アプリケーションでアカウント切り替えのニーズを実現したい場合は、アカウントを切り替えるたびに、login(クリックして詳細を表示)を呼び出すだけで済みます。
たとえば、すでにaliceにログインし、bobに切り替えたい場合は、直接login bobだけで済みます。login bobの前に、logout aliceを明示式に呼び出す必要はなく、IM SDK内部で自動的に処理します。