[]
【重要】2024年1月公開のアップデート「未適用」のお客様へ デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Wijmo_Cloud.Oauth2

OAuth2 クラス

GoogleのGAPI OAuth機能を使用する簡単な方法を提供します。

これを使用するには、OAuth2 クラスのインスタンスを作成し、 userChanged イベントにハンドラーを追加して、ユーザーが 現在サインインしている場合はnullではない {@link @user} プロパティを監視します。

signIn メソッドと signOut メソッドを使用して、Googleアカウントにサインインまたはサインアウトします。

たとえば、次のコードは OAuth2 オブジェクトを作成し、アプリケーションにログインおよび アプリケーションからログアウトできるボタンの管理に使用します。

import { OAuth2 } from '@grapecity/wijmo.cloud';

// OAuth2 オブジェクトを作成します
const API_KEY = 'XXXX';
const CLIENT_ID = 'YYYY.apps.googleusercontent.com';
const SCOPES = [ 'https://www.googleapis.com/auth/userinfo.email' ];
const auth = new OAuth2(API_KEY, CLIENT_ID, SCOPES);

// ボタンをクリックしてログイン/ログアウトします
let oAuthBtn = document.getElementById('auth_btn');
oAuthBtn.addEventListener('click', () => {
    if (auth.user) {
        auth.signOut();
    } else {
        auth.signIn();
    }
});

// ユーザーが変更したときにボタンのキャプションとaccessTokenを更新します
auth.userChanged.addHandler(s => {
    let user = s.user;
    oAuthBtn.textContent = user ? 'Sign Out' : 'Sign In';
    gsNWind.accessToken = user ? s.accessToken : null;
    fsNWind.accessToken = user ? s.accessToken : null;
});

階層

  • OAuth2

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

  • new OAuth2(apiKey: string, clientId: string, scopes?: string[], options?: any): OAuth2

プロパティ

accessToken

accessToken: string

承認されている要求の実行に使用できるOAuthアクセストークンを取得します。

idToken

idToken: string

Firebaseクライアントライブラリに渡せるOAuth IDトークンを取得します。

「https://firebase.google.com/docs/auth/web/google-signin」を参考してください。

let credential = firebase.auth.GoogleAuthProvider.credential(id_token);
firebase.auth().signInWithCredential(credential);

user

user: IUser

現在のユーザーに関する情報（または、ユーザーがサインインしていない場合はnull）を持つオブジェクトを取得します。

メソッド

onError

  • error イベントを発生させます。

    引数

    戻り値 void

onUserChanged

  • userChanged イベントを発生させます。

    引数

    戻り値 void

signIn

  • signIn(): void

  • ユーザーをサインインさせます。

    戻り値 void

signOut

  • signOut(): void

  • ユーザーをサインアウトさせます。

    戻り値 void

イベント

error

error: Event<OAuth2, OAuthError>

エラーが発生したときに発生します。

userChanged

userChanged: Event<OAuth2, EventArgs>

ユーザーがサインインまたはサインアウトすると発生します。