Skip to content

GSC.CybozuConnect.Base

Jump to bottom
K.Kyohei edited this page Feb 23, 2017 · 1 revision

GSC.CybozuConnect.Base

Baseで提供されるAPIを実行するためのクラス

ユーザー情報の属性 

var user = {
    id: "1",                      // ユーザーID
    key: "1",                     // ユーザーID
    login_name: "sato",           // ログイン名
    name: "佐藤",                 // 名前
    status: 1,                    // ユーザーの使用状況
    email: "sato@example.com",    // E-mail アドレス
    primary_organization_id: "1", // 優先する組織のID
    orgIdList: ["1", "2"]         // 所属する組織のIDの配列
};
組織情報の属性 
var org = {
    id: "1",               // 組織ID
    key: "1",              // 組織ID
    name: "営業部",        // 組織名
    userIdList: ["1", "2"] // 所属するユーザーのIDの配列
};

Constuctors

GSC.CybozuConnect.Base(app)

Arguments

  • app (GSC.CybozuConnect.App)

Methods

.isHierarchical()

isHierarchical()

組織構造が階層的か否かを返す。

Returns

(Boolean)

.organization()

organization(orgId)

指定した組織IDの組織情報を返す。

Arguments

  • orgId (String)
    組織ID

Returns

(Object)
組織情報

.organizationList()

organizationList()

トップレベルの組織情報を返す。

Returns

(Array)
組織情報の配列

.primaryOrganization()

primaryOrganization(userId, getFirstIfNotBelong)

指定したユーザーの優先する組織を返す。

Arguments

  • userId (String)
    ユーザーID
  • getFirstIfNotBelong
    true のとき、指定したユーザーが組織に所属していなかった場合、null ではなく、全組織のうち最初の組織を返す。

Returns

(Object)
組織情報

.user()

user(userId)

指定したユーザーIDのユーザー情報を返す。

Arguments

  • userId (String)
    ユーザーID

Returns

(Object)
ユーザー情報。存在しない場合は null。

.userList()

userList()

全ユーザー情報を返す。

Returns

(Array)
ユーザー情報の配列

.userSearch()

userSearch(userText)

ユーザー情報を検索する。

Arguments

  • userText (String)
    検索文字列（ユーザー名、もしくはメールアドレス）

Returns

(Array)
ヒットしたユーザー情報の配列
Clone this wiki locally