Account - imonology/ImonCloud-Doc GitHub Wiki
Account
admin.addUser(i_data, o_onDone, o_onFail) -- 創造使用者帳號
admin.deleteUser(i_data, o_onDone, o_onFail) -- 管理者刪除用戶
admin.listUser(o_onDone, o_onFail) -- 管理者取得所有使用者列表
admin.setUserPassword(i_data, o_onDone, o_onFail) -- 管理者修改用戶密碼
admin.setUserInfo(i_data, o_onDone, o_onFail) -- 管理者修改用戶資訊
admin.getUserInfo(i_data, o_onDone, o_onFail) -- 管理者取得用戶資訊
admin.setUserPermission(i_data, o_onDone, o_onFail) -- 管理者修改用戶權限
admin.getUserPermission(i_data, o_onDone, o_onFail) -- 管理者取得用戶權限
admin.resetAdminPassword(o_onDone, o_onFail) -- 管理者忘記密碼
admin.setAdminPassword(i_data, o_onDone, o_onFail) -- 管理者 - 重設密碼
group.list(o_onDone, o_onFail) -- 管理者取得所有群組列表
group.add(i_data, o_onDone, o_onFail) -- 管理者新增群組
group.delete(i_data, o_onDone, o_onFail) -- 管理者刪除群組
group.listUsers(i_data, o_onDone, o_onFail) -- 管理者取得群組內使用者
group.listDevice(i_data, o_onDone, o_onFail) -- 管理者取得群組內設備
group.addDevice(i_data, o_onDone, o_onFail) -- 管理者新增群組設備
group.deleteDevice(i_data, o_onDone, o_onFail) -- 管理者刪除群組設備
group.addUser(i_data, o_onDone, o_onFail) -- 管理者新增群組使用者
group.deleteUser(i_data, o_onDone, o_onFail) -- 管理者刪除群組使用者
group.setBulkDevice(i_data, o_onDone, o_onFail) -- 管理者重設群組設備
group.setDevice(i_data, o_onDone, o_onFail) -- 管理者修改設備名稱
group.renameGroup(i_data, o_onDone, o_onFail) -- 管理者修改群組名稱
user.login(i_data, i_connObj, o_onDone, o_onFail) -- 登入帳號
user.logout(i_strUUID, o_onDone, o_onFail) -- 登出帳號
user.setInfo(i_data, i_strAccount, o_onDone, o_onFail) -- 使用者設定帳號資訊
user.getInfo(i_strAccount, o_onDone, o_onFail) -- 使用者取得帳號資訊
user.setPassword(i_data, i_strAccount, o_onDone, o_onFail) -- 修改密碼
user.getPermission(i_strAccount, o_onDone, o_onFail) -- 使用者查看帳號權限
user.listGroup(i_data, i_strAccount, o_onDone, o_onFail) -- 使用者查看所在哪些群組
user.getLogin(i_connObj, o_onDone, o_onFail) -- 取得是否登入中
---------------------------------------------------------------
###Account.admin.addUser(i_data, o_onDone, o_onFail);
功能說明：創造使用者帳號
變數說明：
- 傳入(input)
變數名稱: i_data
變數類型: object
變數說明:
i_data =
{
strAccount:帳號,
strPassword:密碼
};
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.admin.addUser(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.admin.deleteUser (i_data, o_onDone, o_onFail);
功能說明：刪除帳號
變數說明：
- 傳入(input)
變數名稱: i_data
變數類型: object
變數說明:
l_data =
{
strAccount:帳號,
}
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.admin.deleteUser(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.admin.listUser (o_onDone, o_onFail);
功能說明：取得使用者列表
變數說明：
- 傳入(input)
無
- 傳出(output)
變數名稱: objUserInfoAr
變數類型: Object[]
變數說明: 使用者帳號資訊陣列
data =
{
string 'strAccount' : //使用者帳號,
string 'strEmail' : //電子信箱,
bool 'bEmailNotify' : //信箱通知勾選,
string 'strPhone' : //電話資料,
bool 'bSMSNotify' : //簡訊通知勾選,
string 'strUserName' : //使用者名稱,
string 'strLanguages' : //語系控制,
bool 'bSystemAegis' : //系統保護,
int 'iLoginCount' : //登入次數,
int 'iLastLogout' : //最後登出時間(年月日時分秒),
}
- 回傳(return)
無
- 範例:
Account.admin.listUser(
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.admin.setUserPassword (i_data, o_onDone, o_onFail);
功能說明：管理者修改用戶密碼
變數說明：
- 傳入(input)
變數名稱: i_data
變數類型: object
變數說明: i_data = { strAccount:帳號, strPassword:密碼 };
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.admin.setUserPassword(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.admin.setUserInfo (i_data, o_onDone, o_onFail);
功能說明：設定使用者資訊
變數說明：
- 傳入(input)
變數名稱: i_data
變數類型: object
變數說明:
i_data=
{
'strAccount': //帳號,
'strEmail': //電子信箱
'bEmailNotify': //信箱通知勾選
'strPhone': //電話資料
'bSMSNotify': //簡訊通知勾選
'strUserName': //使用者名稱
'strLanguages': //語系控制
'bSystemAegis': //系統保護
};
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.admin.setUserInfo(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.admin.getUserInfo (i_data, o_onDone, o_onFail);
功能說明：管理者取得使用者權限
變數說明：
- 傳入(input)
變數名稱: i_data
變數類型: object
變數說明:
i_data =
{
'strAccount'://帳號,
};
- 傳出(output)
變數名稱: l_obj定義
變數類型: Object
變數說明:
l_obj =
{
'strEmail': //電子信箱
'bEmailNotify': //信箱通知勾選
'strPhone': //電話資料
'bSMSNotify': //簡訊通知勾選
'strUserName': //使用者名稱
'strLanguages': //語系控制
'bSystemAegis': //系統保護
};
- 回傳(return)
無
- 範例:
Account.admin.getUserInfo(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.admin.setUserPermission (i_data, o_onDone, o_onFail);
功能說明：設定使用者權限
變數說明：
- 傳入(input)
變數名稱: i_data
變數類型: object
變數說明:
i_data =
{
'strAccount'://帳號,
'bVideo': //控制錄影權限
'bPlayback': //操作回放權限
'bMoveScale': //設備位移縮放
'bAdjustment': //影像調整權限
'bSetDate': //設定日期時間
'bSetDeviceName': //設定設備名稱
'bSetFPS': //設定FPS
'bSetSubtitle': //設定字幕打印
'bAlertEvent': //警報事件處理
'bBackup': //下載備份權限
'bPhotograph': //拍照畫面權限
'bUpdate': //軟體更新權限
'bLogin': //登入系統權限
};
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.admin.setUserPermission(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.admin.getUserPermission (i_data, o_onDone, o_onFail);
功能說明：管理者取得使用者權限
變數說明：
- 傳入(input)
變數名稱: i_data
變數類型: object
變數說明:
i_data =
{
'strAccount'://帳號,
};
- 傳出(output)
變數名稱: l_obj定義
變數類型: Object
變數說明:
l_obj =
{
'bVideo': 控制錄影權限
'bPlayback': 操作回放權限
'bMoveScale': 設備位移縮放
'bAdjustment': 影像調整權限
'bSetDate': 設定日期時間
'bSetDeviceName': 設定設備名稱
'bSetFPS': 設定FPS
'bSetSubtitle': 設定字幕打印
'bAlertEvent': 警報事件處理
'bBackup': 下載備份權限
'bPhotograph': 拍照畫面權限
'bUpdate': 軟體更新權限
'bLogin': 登入權限
};
- 回傳(return)
無
- 範例:
Account.admin.getUserPermission(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.admin.resetAdminPassword (o_onDone, o_onFail);
功能說明：管理者 - 忘記密碼
變數說明：
- 傳入(input)
無
- 傳出(output)
變數名稱: l_obj
變數類型: Object
變數說明: l_obj = {'strVersion': 版本號, 'strCustomerService': 客服電話};
- 回傳(return)
無
- 範例:
Account.admin.resetAdminPassword(
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.admin.setAdminPassword(i_data, o_onDone, o_onFail);
功能說明：管理者 - 重設密碼
變數說明：
- 傳入(input)
變數名稱: i_data
變數類型: object
變數說明: l_data = { strNewPassword:新密碼, }
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.admin.setAdminPassword(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.group.list(o_onDone, o_onFail);
功能說明：取得群組列表
變數說明：
- 傳入(input)
無
- 傳出(output)
變數名稱: objGroupAr
變數類型: object[]
變數說明: 群組名稱陣列
l_data =
{
'strGroupName': 群組名稱,
'iGroupId': 群組ID
}
- 回傳(return)
無
- 範例:
Account.group.list(
function (ii_dataAr)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.group.add(i_data, o_onDone, o_onFail);
功能說明：新增群組
變數說明：
- 傳入(input)
變數名稱: l_data
變數類型: Object
變數說明: l_data = { strGroupName:群組名稱, }
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.group.add(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.group.delete(i_data, o_onDone, o_onFail);
功能說明：刪除群組
變數說明：
- 傳入(input)
變數名稱: l_data
變數類型: Object
變數說明: l_data = { 'iGroupId':群組ID, }
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.group.delete(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.group.listUsers(i_data, o_onDone, o_onFail);
功能說明：取得使用者列表
變數說明：
- 傳入(input)
變數名稱: l_data
變數類型: Object
變數說明: l_data = { 'iGroupId':群組ID, }
- 傳出(output)
變數名稱: l_strUserAr
變數類型: String[]
變數說明: 使用者帳號陣列
- 回傳(return)
無
- 範例:
Account.group.listUsers(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.group.listDevice(i_data, o_onDone, o_onFail);
功能說明：取得設備列表
變數說明：
- 傳入(input)
變數名稱: l_data
變數類型: Object
變數說明: l_data = { 'iGroupId':群組ID, }
- 傳出(output)
變數名稱: l_strDeviceAr
變數類型: String[]
變數說明: 設備名稱陣列
- 回傳(return)
無
- 範例:
Account.group.listDevice(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.group.addDevice(i_data, o_onDone, o_onFail);
功能說明：群組內加入設備
變數說明：
- 傳入(input)
變數名稱: l_data
變數類型: Object
變數說明: l_data = { 'iGroupId':群組ID, 'strDevice':設備 }
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.group.addDevice(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.group.deleteDevice(i_data, o_onDone, o_onFail);
功能說明：群組內移除設備
變數說明：
- 傳入(input)
變數名稱: l_data
變數類型: Object
變數說明: l_data = { 'iGroupId':群組ID, 'strDevice':設備 }
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.group.deleteDevice(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.group.addUser(i_data, o_onDone, o_onFail);
功能說明：群組內加入帳號
變數說明：
- 傳入(input)
變數名稱: l_data
變數類型: Object
變數說明: l_data = { 'iGroupId':群組ID, 'strAccount':帳號 }
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.group.addUser(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.group.deleteUser(i_data, o_onDone, o_onFail);
功能說明：群組內移除帳號
變數說明：
- 傳入(input)
變數名稱: l_data
變數類型: Object
變數說明: l_data = { 'iGroupId':群組ID, 'strAccount':帳號 }
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.group.deleteUser(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.group.setBulkDevice(i_data, o_onDone, o_onFail);
功能說明：群組內重設設備列表
變數說明：
- 傳入(input)
變數名稱: l_data
變數類型: Object
變數說明: l_data = { 'iGroupId':群組ID, 'strDeviceAr':設備表 }
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.group.setBulkDevice(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.group.setDevice(i_data, o_onDone, o_onFail);
功能說明：修改設備名稱
變數說明：
- 傳入(input)
變數名稱: l_data
變數類型: Object
變數說明: l_data = { strDevice:設備名稱, strNewDevice:新設備名稱 }
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.group.setDevice(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.group.renameGroup(i_data, o_onDone, o_onFail);
功能說明：管理者修改群組名稱
變數說明：
- 傳入(input)
變數名稱: l_data
變數類型: Object
變數說明: l_data = { strOldGroupName:舊的名稱, strNewGroupName:新名稱 }
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.group.renameGroup(l_data,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.user.login(i_data, i_connObj, o_onDone, o_onFail);
功能說明：帳號登入
變數說明：
- 傳入(input)
變數名稱: l_data
變數類型: Object
變數說明: l_data = { strAccount:帳號, strPassword:密碼 }
- 傳出(output)
變數名稱: l_obj
變數類型: Object
變數說明:
l_obj =
{
int 'iReturn': 事件編號,(-99忘記密碼 0正常登入)
string 'strAccount': 使用者帳號,
string 'strUUID': 登入編號,
int 'iLoginCount': 登入次數,
string 'strLoginTime': 登入時間("2015/7/14 17:36:46"),
string 'strIP': IP,
object 'objPermissions': 權限(物件)
};
- 回傳(return)
無
- 範例:
Account.user.login(l_data, i_event.conn,
function (ii_data)
{
if (ii_data.bForget != undefined)
{
}
else
{
}
},
function ()
{
});
---------------------------------------------------------------
###Account.user.logout(i_strUUID, o_onDone, o_onFail);
功能說明：帳號登出
變數說明：
- 傳入(input)
變數名稱: i_strUUID
變數類型: string
變數說明: UUID
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.user.logout(strUUID,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.user.setInfo(i_data, i_strAccount, o_onDone, o_onFail);
功能說明：設定帳號資訊
變數說明：
- 傳入(input)
變數名稱: i_data
變數類型: Object
變數說明:
i_data=
{
'strEmail': //電子信箱
'bEmailNotify': //信箱通知勾選
'strPhone': //電話資料
'bSMSNotify': //簡訊通知勾選
'strUserName': //使用者名稱
'strLanguages': //語系控制
'bSystemAegis': //系統保護
};
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.user.setInfo(l_data, l_user.strAccount,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.user.getInfo(i_strAccount, o_onDone, o_onFail);
功能說明：取得帳號資訊
變數說明：
- 傳入(input)
無
- 傳出(output)
變數名稱: 沒有定義
變數類型: Object
變數說明:
l_obj =
{
'strEmail': //電子信箱
'bEmailNotify': //信箱通知勾選
'strPhone': //電話資料
'bSMSNotify': //簡訊通知勾選
'strUserName': //使用者名稱
'strLanguages': //語系控制
'bSystemAegis': //系統保護
};
- 回傳(return)
無
- 範例:
Account.user.getInfo(l_user.strAccount,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.user.setPassword(i_data, i_strAccount, o_onDone, o_onFail);
功能說明：修改密碼
變數說明：
- 傳入(input)
變數名稱: l_data 變數類型: Object 變數說明: l_data = { 'strOldPassword': //原本的密碼 'strNewPassword': //新的密碼 }
- 傳出(output)
變數名稱: iReturn
變數類型: int
變數說明: 0(成功)，1(失敗)
- 回傳(return)
無
- 範例:
Account.user.setPassword(l_data, l_user.strAccount,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.user.getPermission(i_strAccount, o_onDone, o_onFail);
功能說明：查看帳號權限
變數說明：
- 傳入(input)
無
- 傳出(output)
變數名稱: l_obj定義
變數類型: Object
變數說明:
l_obj =
{
'bVideo': 控制錄影權限
'bPlayback': 操作回放權限
'bMoveScale': 設備位移縮放
'bAdjustment': 影像調整權限
'bSetDate': 設定日期時間
'bSetDeviceName': 設定設備名稱
'bSetFPS': 設定FPS
'bSetSubtitle': 設定字幕打印
'bAlertEvent': 警報事件處理
'bBackup': 下載備份權限
'bPhotograph': 拍照畫面權限
'bUpdate': 軟體更新權限
'bLogin': 登入權限
};
- 回傳(return)
無
- 範例:
Account.user.getPermission(l_user.strAccount,
function (ii_data)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.user.listGroup(i_data, i_strAccount, o_onDone, o_onFail);
功能說明：查看群組
變數說明：
- 傳入(input)
無
- 傳出(output)
變數名稱: l_strGroupAr
變數類型: String[]
變數說明: 群組名稱陣列
- 回傳(return)
無
- 範例:
Account.user.listGroup(l_data, l_user.strAccount,
function (ii_dataAr)
{
},
function ()
{
});
---------------------------------------------------------------
###Account.user.getLogin(i_connObj, o_onDone, o_onFail);
功能說明：取得是否登入中
變數說明：
- 傳入(input)
無
- 傳出(output)
變數名稱: 沒有定義
變數類型: string
變數說明: 在線上回傳 : 帳號，不在線上回傳 : null
- 回傳(return)
無
- 範例:
Account.user.getLogin(i_event.conn,
function (ii_data)
{
},
function ()
{
});