• English

onLogin

このハンドラーは、エージェントがエージェントデスクトップアプリケーションにログインした際に呼び出されます。

リクエスト

構文

on('ON_LOGIN', handler: OnLoginHandler): void type OnLoginHandler = (loginState: LoginStateData) => void type LoginStateData = { isLoggedIn: boolean agentId?: string username?: string sessionId?: string }

パラメータ

パラメータ	パラメータ値	データ型	オプション／必須	説明
loginState
	isLoggedIn	ブール値	必須	常に true
	agentId	文字列	オプション	ログイン中のエージェントのID
	username	文字列	オプション	ログイン中のエージェントのユーザー名
	sessionId	文字列	オプション	現在のログインセッションのID

例

function loginCallback(data: LoginStateData) {

// ...

}

adApi.on("ON_LOGIN", loginCallback);

戻り値

(なし)

< 前へ | 次へ >