M3Api

所有已知实现类:

AbstractM3Api
```
public interface M3Api
```

方法概要

所有方法实例方法抽象方法已过时的方法
限定符和类型	方法和说明
`boolean`	`addConfig(java.lang.String group, java.lang.String item, java.lang.String value)`
`void`	`buildBaseApp(com.seeyon.ctp.common.file.model.CtpFile... buildAppFile)` 自定义基础应用包
`void`	`buildBaseApp(com.seeyon.ctp.common.file.model.CtpLocalFile... buildAppFile)`
`void`	`buildCap4App(com.seeyon.ctp.common.file.model.CtpFile... buildAppFile)` 部署CAP4应用包此方法会根据传入的包文件自动部署到\2007\01\01\m3\apps对应目录中。
`boolean`	`checkAddressBookFieldIsView(java.lang.Long accountId, java.lang.String fieldName)` 检查是否显示此字段
`boolean`	`checkFileExit(java.lang.String path, java.lang.String fileName)`
`boolean`	`fileToZip(java.lang.String sourceFilePath, java.lang.String zipFilePath, java.lang.String fileName)`
`java.util.List<M3ConcernMemberBo>`	`getAllConcernMember()` 获取所有的关注人员
`java.util.List<java.util.Map<java.lang.String,java.lang.String>>`	`getAppsAllByList()` 获取所有标准应用(v5+m3)
`java.util.Map<java.lang.String,java.lang.Object>`	`getBusinessMsgData(java.lang.String userHistoryMessageJson)` 获取M3移动端转发的业务消息相关数据代替getBusinessMsgData(UserHistoryMessage userHistoryMessage)
`com.seeyon.ctp.util.FlipInfo`	`getConcernMember(int pageNo, int pageSize)` 获取显示用的关注人员列表（分页）
`java.util.Map<java.lang.String,java.lang.Object>`	`getConfigItem(java.lang.Long memberId, java.lang.Long accountId, java.lang.String group, java.lang.String item)`
`java.util.Map<java.lang.String,java.lang.Object>`	`getCurrentAdminSet(java.lang.String phoneType, java.lang.Long accountId)` 获取当前人的配置
`boolean`	`getCurrentPortalSetCanModiefy()` 判断当前用户底导航是否有编辑权限
`java.util.List<java.util.Map<java.lang.String,java.lang.Object>>`	`getCurrnetUserAppInfoListData()` 获取当前登录用户的应用列表
`java.util.List<M3AppInfoListSimpleVO>`	`getCurrnetUserAppInfoListVO()` 获取当前登录用户的应用列表
`java.lang.String`	`getFileFormat()`
`java.lang.String`	`getIsignatureKeysn(java.lang.Long userId)` 根据ID获取用户绑定的签章狗号正常： 1传入一个未绑定签章狗的用户ID，返回签章狗号为空 2、传入一个绑定签章狗的内部用户ID，返回签章狗号正确 3、传入一个绑定签章狗的编外人员用户ID，返回签章狗号正确异常： 1、传入一个未绑定签章狗的停用人员ID，返回不报错 2、传入ID为空，抛出异常 3、传入一个已绑定签章狗的停用人员ID，返回不报错
`java.lang.String`	`getMobilePassUrl(java.lang.String messageId)` 获取M3移动端转发的业务消息，移动端穿透URL
`java.lang.String`	`getOfficeAuthKey(java.lang.Long userId)` 已过时。取消该方法，返回值为 null
`java.util.Map<java.lang.String,java.lang.Object>`	`getOfficeAuthKeyAndWPSKey(java.lang.Long userId)` 根据id获取用户office授权key和金格WPS ios和android(预留)授权码正常： 1、传入一个没有office授权的用户ID，返回授权码为空 2、传入一个有office授权的内部用户ID，返回office狗中office key信息 3、传入一个有office授权的编外人员用户ID，返回office狗中office key信息异常： 1、传入一个没有office授权的停用人员ID，返回不报错 2、传入ID为空，抛出异常 3、传入一个有office授权的停用人员ID，返回不报错
`java.lang.String`	`getOfflineDirectory()` 获取m3离线通讯录文件目录
`java.lang.String`	`getOfflineZipDirectory()`
`java.lang.String`	`getServerBarCodeId()` 获取M3服务器地址二维码图片文件fileId ，用于pc端登录页显示
`java.lang.String`	`getServerIdentifier()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getUpgradeInfo()` 获取M3升级的信息
`java.io.BufferedWriter`	`getWriterInstance(java.lang.String path, java.lang.String fileName, java.lang.String format, boolean init)`
`boolean`	`hasResourcePriv(java.lang.String resourceCode)` 根据 resource code 判断是否有对应的菜单权限
`void`	`hotBuildApp()` 热部署M3应用包调用此方法执行一次M3 H5应用ZIP包自动热部署。
`void`	`initSupervisionM3NavBar(java.util.Map<java.lang.String,java.lang.Object> params)` M3预制底导航
`boolean`	`isCap4AppExists(java.lang.String appFileName)` 判断 CAP4 应用包是否存在
`boolean`	`isConcernedMember(long concernMemberId)` 判断人员是否是被关注了的
`void`	`isShowCapMallBanner(boolean isShow)` 是否显示M3应用中心致远协同云Banner图片
`void`	`removeConcernMember(long memberId)` 移除关注人员
`void`	`saveConcernMember(java.util.List<M3ConcernMemberBo> voList)` 保存关注人员
`boolean`	`updateConfig(java.util.Map<java.lang.String,java.lang.Object> item)`

- 方法详细资料
  - getIsignatureKeysn
```
java.lang.String getIsignatureKeysn(java.lang.Long userId)
                             throws com.seeyon.ctp.common.exceptions.BusinessException
```
    根据ID获取用户绑定的签章狗号正常：
    1传入一个未绑定签章狗的用户ID，返回签章狗号为空
    2、传入一个绑定签章狗的内部用户ID，返回签章狗号正确
    3、传入一个绑定签章狗的编外人员用户ID，返回签章狗号正确
    异常：
    1、传入一个未绑定签章狗的停用人员ID，返回不报错
    2、传入ID为空，抛出异常 3、传入一个已绑定签章狗的停用人员ID，返回不报错
    
    参数:
    
    userId -
    
    返回:
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - getOfficeAuthKey
```
@Deprecated
java.lang.String getOfficeAuthKey(java.lang.Long userId)
                                        throws com.seeyon.ctp.common.exceptions.BusinessException
```
    已过时。取消该方法，返回值为 null
    
    根据id获取用户office授权key 正常：
    1、传入一个没有office授权的用户ID，返回签章狗号为空
    2、传入一个有office授权的内部用户ID，返回签章狗号正确
    3、传入一个有office授权的编外人员用户ID，返回签章狗号正确
    异常：
    1、传入一个没有office授权的停用人员ID，返回不报错
    2、传入ID为空，抛出异常 3、传入一个有office授权的停用人员ID，返回不抱错
    
    参数:
    
    userId -
    
    返回:
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - getOfficeAuthKeyAndWPSKey
```
java.util.Map<java.lang.String,java.lang.Object> getOfficeAuthKeyAndWPSKey(java.lang.Long userId)
                                                                    throws com.seeyon.ctp.common.exceptions.BusinessException
```
    根据id获取用户office授权key和金格WPS ios和android(预留)授权码正常：
    1、传入一个没有office授权的用户ID，返回授权码为空
    2、传入一个有office授权的内部用户ID，返回office狗中office key信息
    3、传入一个有office授权的编外人员用户ID，返回office狗中office key信息
    异常：
    1、传入一个没有office授权的停用人员ID，返回不报错
    2、传入ID为空，抛出异常 3、传入一个有office授权的停用人员ID，返回不报错
    
    参数:
    
    userId -
    
    返回:
    
    Map { "officeAuth"//string 当前用户是否有权限 "officeAuthKey" // String office授权key "iOSWpsKey" // String 金格wps IOS 授权码 "androidWpsKey" // String 金格wps Android 授权码（扩展预留） }
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - getServerBarCodeId
```
java.lang.String getServerBarCodeId()
                             throws com.seeyon.ctp.common.exceptions.BusinessException
```
    获取M3服务器地址二维码图片文件fileId ，用于pc端登录页显示
    
    返回:
    
    返回二维码图片文件fileId
    其中，返回值是图片文件的fileId ，如果为null则说明管理员没有设置过二维码图片或者无M3插件，前端根据fileId 拼接成标准的文件下载接口来显示该图片，如： {ip}/seeyon/fileUpload.do?method=showRTE&fileId={fileId}&type=image
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - hotBuildApp
```
void hotBuildApp()
          throws com.seeyon.ctp.common.exceptions.BusinessException
```
    热部署M3应用包
    调用此方法执行一次M3 H5应用ZIP包自动热部署。此部署会将\ApacheJetspeed\webapps\seeyon\m3files目录下的V5或者M3应用包直接拷贝到分区目录中的\2007\01\01\m3\apps对应目录中，过程中会对包做解析，但不会返回任何解析成功或者失败数据，如有错误信息需要查看日志文件。
    
    注意：因包解析资源可能消耗较大（根据实际包大小），因此请勿频繁调用，否则可能会对系统性能造成影响。
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - buildBaseApp
```
void buildBaseApp(com.seeyon.ctp.common.file.model.CtpFile... buildAppFile)
           throws com.seeyon.ctp.common.exceptions.BusinessException
```
    自定义基础应用包
    
    参数:
    
    buildAppFile -
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - buildBaseApp
```
void buildBaseApp(com.seeyon.ctp.common.file.model.CtpLocalFile... buildAppFile)
           throws com.seeyon.ctp.common.exceptions.BusinessException
```
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - buildCap4App
```
void buildCap4App(com.seeyon.ctp.common.file.model.CtpFile... buildAppFile)
           throws com.seeyon.ctp.common.exceptions.BusinessException
```
    部署CAP4应用包
    此方法会根据传入的包文件自动部署到\2007\01\01\m3\apps对应目录中。部署过程中会对应用包进行检查。所有检查不通过都将直接抛出异常。
    
    注意：因包解析资源可能消耗较大（根据实际包大小），因此请勿频繁调用，否则可能会对系统性能造成影响。
    
    参数:
    
    buildAppFile - CAP4应用包原文件
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - getMobilePassUrl
```
java.lang.String getMobilePassUrl(java.lang.String messageId)
                           throws com.seeyon.ctp.common.exceptions.BusinessException
```
    获取M3移动端转发的业务消息，移动端穿透URL
    
    参数:
    
    messageId - 用户消息ID
    
    返回:
    
    Url 移动端穿透URL
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - getBusinessMsgData
```
java.util.Map<java.lang.String,java.lang.Object> getBusinessMsgData(java.lang.String userHistoryMessageJson)
                                                             throws com.seeyon.ctp.common.exceptions.BusinessException
```
    获取M3移动端转发的业务消息相关数据代替getBusinessMsgData(UserHistoryMessage userHistoryMessage)
    
    参数:
    
    userHistoryMessageJson -
    
    返回:
    
    Map { "gotoParams" // 穿透数据 "actionType" // 操作类型，0：只读，1：可穿透，等等 }
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - getCurrnetUserAppInfoListData
```
java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getCurrnetUserAppInfoListData()
                                                                                        throws com.seeyon.ctp.common.exceptions.BusinessException
```
    获取当前登录用户的应用列表
    
    返回:
    
    应用数据列表对象
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - getUpgradeInfo
```
java.util.Map<java.lang.String,java.lang.Object> getUpgradeInfo()
                                                         throws com.seeyon.ctp.common.exceptions.BusinessException
```
    获取M3升级的信息
    
    返回:
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - getAppsAllByList
```
java.util.List<java.util.Map<java.lang.String,java.lang.String>> getAppsAllByList()
```
    获取所有标准应用(v5+m3)
    
    返回:
  - getCurrentAdminSet
```
java.util.Map<java.lang.String,java.lang.Object> getCurrentAdminSet(java.lang.String phoneType,
                                                                    java.lang.Long accountId)
                                                             throws com.seeyon.ctp.common.exceptions.BusinessException
```
    获取当前人的配置
    
    参数:
    
    accountId -
    
    返回:
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - isConcernedMember
```
boolean isConcernedMember(long concernMemberId)
                   throws com.seeyon.ctp.common.exceptions.BusinessException
```
    判断人员是否是被关注了的
    
    参数:
    
    concernMemberId -
    
    返回:
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - getOfflineDirectory
```
java.lang.String getOfflineDirectory()
```
    获取m3离线通讯录文件目录
    
    返回:
  - getFileFormat
```
java.lang.String getFileFormat()
```
  - getWriterInstance
```
java.io.BufferedWriter getWriterInstance(java.lang.String path,
                                         java.lang.String fileName,
                                         java.lang.String format,
                                         boolean init)
                                  throws java.lang.Exception
```
    抛出:
    
    java.lang.Exception
  - getOfflineZipDirectory
```
java.lang.String getOfflineZipDirectory()
```
  - checkFileExit
```
boolean checkFileExit(java.lang.String path,
                      java.lang.String fileName)
```
  - fileToZip
```
boolean fileToZip(java.lang.String sourceFilePath,
                  java.lang.String zipFilePath,
                  java.lang.String fileName)
```
  - getConcernMember
```
com.seeyon.ctp.util.FlipInfo getConcernMember(int pageNo,
                                              int pageSize)
                                       throws com.seeyon.ctp.common.exceptions.BusinessException
```
    获取显示用的关注人员列表（分页）
    
    返回:
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - getAllConcernMember
```
java.util.List<M3ConcernMemberBo> getAllConcernMember()
                                               throws com.seeyon.ctp.common.exceptions.BusinessException
```
    获取所有的关注人员
    
    返回:
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - removeConcernMember
```
void removeConcernMember(long memberId)
                  throws com.seeyon.ctp.common.exceptions.BusinessException
```
    移除关注人员
    
    参数:
    
    memberId -
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - saveConcernMember
```
void saveConcernMember(java.util.List<M3ConcernMemberBo> voList)
                throws com.seeyon.ctp.common.exceptions.BusinessException
```
    保存关注人员
    
    参数:
    
    voList -
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - getServerIdentifier
```
java.lang.String getServerIdentifier()
```
  - getConfigItem
```
java.util.Map<java.lang.String,java.lang.Object> getConfigItem(java.lang.Long memberId,
                                                               java.lang.Long accountId,
                                                               java.lang.String group,
                                                               java.lang.String item)
```
  - updateConfig
```
boolean updateConfig(java.util.Map<java.lang.String,java.lang.Object> item)
```
  - addConfig
```
boolean addConfig(java.lang.String group,
                  java.lang.String item,
                  java.lang.String value)
```
  - checkAddressBookFieldIsView
```
boolean checkAddressBookFieldIsView(java.lang.Long accountId,
                                    java.lang.String fieldName)
                             throws com.seeyon.ctp.common.exceptions.BusinessException
```
    检查是否显示此字段
    
    参数:
    
    fieldName - 通讯录字段
    
    返回:
    
    boolean
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - hasResourcePriv
```
boolean hasResourcePriv(java.lang.String resourceCode)
```
    根据 resource code 判断是否有对应的菜单权限
    
    参数:
    
    resourceCode -
    
    返回:
    
    true:有权限; false:无权限
  - getCurrentPortalSetCanModiefy
```
boolean getCurrentPortalSetCanModiefy()
                               throws com.seeyon.ctp.common.exceptions.BusinessException
```
    判断当前用户底导航是否有编辑权限
    
    返回:
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - isCap4AppExists
```
boolean isCap4AppExists(java.lang.String appFileName)
                 throws com.seeyon.ctp.common.exceptions.BusinessException
```
    判断 CAP4 应用包是否存在
    
    参数:
    
    appFileName -
    
    返回:
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - getCurrnetUserAppInfoListVO
```
java.util.List<M3AppInfoListSimpleVO> getCurrnetUserAppInfoListVO()
                                                           throws com.seeyon.ctp.common.exceptions.BusinessException
```
    获取当前登录用户的应用列表
    
    返回:
    
    应用数据列表对象
    
    抛出:
    
    com.seeyon.ctp.common.exceptions.BusinessException
  - initSupervisionM3NavBar
```
void initSupervisionM3NavBar(java.util.Map<java.lang.String,java.lang.Object> params)
```
    M3预制底导航
    
    参数:
    
    params -
  - isShowCapMallBanner
```
void isShowCapMallBanner(boolean isShow)
```
    是否显示M3应用中心致远协同云Banner图片
    
    参数:
    
    isShow -

接口 M3Api

方法概要

方法详细资料

getIsignatureKeysn

getOfficeAuthKey

getOfficeAuthKeyAndWPSKey

getServerBarCodeId

hotBuildApp

buildBaseApp

buildBaseApp

buildCap4App

getMobilePassUrl

getBusinessMsgData

getCurrnetUserAppInfoListData

getUpgradeInfo

getAppsAllByList

getCurrentAdminSet

isConcernedMember

getOfflineDirectory

getFileFormat

getWriterInstance

getOfflineZipDirectory

checkFileExit

fileToZip

getConcernMember

getAllConcernMember

removeConcernMember

saveConcernMember

getServerIdentifier

getConfigItem

updateConfig

addConfig

checkAddressBookFieldIsView

hasResourcePriv

getCurrentPortalSetCanModiefy

isCap4AppExists

getCurrnetUserAppInfoListVO

initSupervisionM3NavBar

isShowCapMallBanner