AccountContextオブジェクト

コンポーネント情報
version	8.0.15
since	8.0.0

コンポーネント概要

アカウントコンテキストオブジェクト。

アクセスしたアカウントに関する情報を保持するアクセスコンテキストです。
ユーザコードやロケールなどのアカウント情報、認証状況などを取得できます。
このクラスは必須のアクセスコンテキストであり、運用中は常に取得可能なアクセスコンテキストです。

アクセスコンテキストの情報は、ユーザの種別によらず定義された解決順序によって適切な値が取得できます。
各設定値は、アカウント設定情報、テナントのアカウント設定情報、ブラウザ情報、システムデフォルトのアカウント設定情報、サーバ環境設定情報の順序で参照します。
詳細は「アクセスコンテキスト仕様書」の「アカウントコンテキスト」を参照してください。

以下のコードにより取得できます。

 var accountContext = Contexts.getAccountContext();

オブジェクトの構造

var accountContext = {
    applicationLicenses : Array, // アプリケーションライセンス(String)の一覧。
    authenticated : Boolean, // 認証状況。
    calendarId : String, // カレンダーID。
    dateTimeFormats : Object, // 日時表示形式一覧。
    decimalFormatId : String, // 数値形式のフォーマットID。
    encoding : String, // 文字エンコーディング。
    firstDayOfWeek : Number, // 週の開始曜日。
    homeUrl : String, // ホームURL。
    locale : String, // ロケール。
    loginGroupId : String, // ログイングループID。非推奨です。テナントIDと同じ値が取得されます。
    loginTime : Date, // ログイン時間。
    roleIds : Array, // ロールID(String)の一覧。
    signature : String, // ログイン署名。
    tenantId : String, // テナントID。
    themeId : String, // テーマID。
    timeZone : TimeZone, // タイムゾーン。
    userCd : String, // ユーザID。
    userType : String // ユーザ種別。
}

var accountContext = {
    applicationLicenses : Array, // アプリケーションライセンス(String)の一覧。
    authenticated : Boolean, // 認証状況。
    calendarId : String, // カレンダーID。
    dateTimeFormats : Object, // 日時表示形式一覧。
    decimalFormatId : String, // 数値形式のフォーマットID。
    encoding : String, // 文字エンコーディング。
    firstDayOfWeek : Number, // 週の開始曜日。
    homeUrl : String, // ホームURL。
    locale : String, // ロケール。
    loginGroupId : String, // ログイングループID。非推奨です。テナントIDと同じ値が取得されます。
    loginTime : Date, // ログイン時間。
    roleIds : Array, // ロールID(String)の一覧。
    signature : String, // ログイン署名。
    tenantId : String, // テナントID。
    themeId : String, // テーマID。
    timeZone : TimeZone, // タイムゾーン。
    userCd : String, // ユーザID。
    userType : String // ユーザ種別。
}

プロパティの概要

型	プロパティ名	アクセス権
Array	applicationLicenses アプリケーションライセンス(`String`)の一覧。	通常
Boolean	authenticated 認証状況。	通常
String	calendarId カレンダーID。	通常
Object	dateTimeFormats 日時表示形式一覧。	通常
String	decimalFormatId 数値形式のフォーマットID。	通常
String	encoding 文字エンコーディング。	通常
Number	firstDayOfWeek 週の開始曜日。	通常
String	homeUrl ホームURL。	通常
String	locale ロケール。	通常
String	loginGroupId ログイングループID。非推奨です。テナントIDと同じ値が取得されます。	通常
Date	loginTime ログイン時間。	通常
Array	roleIds ロールID(`String`)の一覧。	通常
String	signature ログイン署名。	通常
String	tenantId テナントID。	通常
String	themeId テーマID。	通常
TimeZone	timeZone タイムゾーン。	通常
String	userCd ユーザID。	通常
String	userType ユーザ種別。	通常

プロパティの詳細

Array applicationLicenses 通常

アプリケーションライセンス(String)の一覧。

Boolean authenticated 通常

認証状況。
ログイン済みの場合、true が取得されます。

String calendarId 通常

カレンダーID。

Object dateTimeFormats 通常

日時表示形式一覧。
Object のキーと値に格納する内容は、 SystemDateTimeFormat#getFormats メソッドの説明をご覧ください。

String decimalFormatId 通常

数値形式のフォーマットID。
このプロパティはバージョン 8.0.15 より利用可能です。

String encoding 通常

文字エンコーディング。

Number firstDayOfWeek 通常

週の開始曜日。
次の値が設定されます。 0：日曜～ 6：土曜

String homeUrl 通常

ホームURL。

String locale 通常

ロケール。

String loginGroupId 通常

ログイングループID。非推奨です。テナントIDと同じ値が取得されます。
利用しないでください。このプロパティは、互換用APIの内部で利用されます。

Date loginTime 通常

ログイン時間。
ログインしていない場合、null が取得されます。

Array roleIds 通常

ロールID(String)の一覧。
サブロールも含まれます。

String signature 通常

ログイン署名。
ログインしていない場合、null が取得されます。

String tenantId 通常

テナントID。
このプロパティはバージョン 8.0.7 より利用可能です。

String themeId 通常

テーマID。

TimeZone timeZone 通常

タイムゾーン。

String userCd 通常

ユーザID。

String userType 通常

ユーザ種別。
administrator（システム管理者）または user（一般ユーザ）が取得されます。