• English

getLoginState

ユーザーが認証された場合、ログイン状態、セッションID、およびエージェントIDを取得します。

リクエスト

構文

getLoginState(): Promise<OperationResult<LoginStateData>>

ここで：

type LoginStateData = { isLoggedIn: boolean agentId?: string username?: string sessionId?: string }

パラメータ

(なし)

リクエスト例

  getLoginStateButton.onclick = () => {

adApi.getLoginState()

}

戻り値

オブジェクト	オブジェクトの値	データ型	オプションですか？ (Y/N)	戻り値の説明
LoginStateData
	isLoggedIn	ブール値	N	値が true の場合はエージェントがログインしており、false の場合はログインしていません。
	agentId	文字列	Y	リクエストを行ったユーザーが適切な権限を持っている場合、この値はユーザーのエージェントIDを返します。
	username	文字列	Y	リクエストを行ったユーザーが適切な権限を持っている場合、この値はユーザーのユーザー名を返します。
	sessionId	文字列	Y	リクエスト元のユーザーが適切な権限を持っている場合、この値は現在のセッションIDを返します。

< 前へ | 次へ >