[]
        
(Showing Draft Content)

Wijmo_Cloud.Oauth2

OAuth2 クラス

deprecated

since version 5.20231.* Please use Google's own authentication methods.

Provides a simple way to use Google's GAPI OAuth functionality.

To use, create an instance of the OAuth2 class and add a handler to the userChanged event to monitor the {@link @user} property, which is non-null if a user is currently signed in.

Use the signIn and signOut methods to sign in or out of the Google account.

For example, the code below creates an OAuth2 object and uses it to manage a button used to log users in and out of the application:

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

// create OAuth2 object
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);

// click a button to log in/out
let oAuthBtn = document.getElementById('auth_btn');
oAuthBtn.addEventListener('click', () => {
    if (auth.user) {
        auth.signOut();
    } else {
        auth.signIn();
    }
});

// update button caption and accessToken when user changes
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

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

userChanged

userChanged: Event<OAuth2, EventArgs>

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