服务API

作者: 狐狸大师 | 来源:发表于2017-08-08 23:30 被阅读0次

API服务平台，RestCloud服务编排平台
2020-01-14周二
极光推送开发第二弹——极光推送API
服务API
服务API
Learning Openstack Part2 Opensta
Web 开发应用技术导图（未完，待续···）
Kubernetes API 介绍
API服务器架设笔记（flask+nginx+uwsig）
Rest API的认证模式

HttpService
UserService
ConfirmationService
AuthGuardService
TranslateService
LocalStorageService
SessionStorageService
InteractionService
FlyReportService
FormValidationService
SimpleUUIDService

HttpService

跟服务器交互的服务

方法：HttpService.post(url,params,options)
作用：发送请求，获取数据

参数

url:请求地址

params:请求参数

options:请求配置对象 = {
method?: string //默认POST
showLoading?: boolean; //默认true
useDefaultFaild?: boolean;//默认false
isAbsolutePath?: boolean;
timeout?: number; //超时时间，默认是120秒
async?: boolean;
}

例子

 this.HttpService.post("/api/business/leave!queryEntityById",{id:this.businesskey}).subscribe((result)=>{
          //console.log(result);
});

方法：HttpService.downLoadFile(url,params)
作用：下载文件

参数

url:请求地址

params:请求参数

例子

this.HttpService.downLoadFile("/api/report/reportBase!exportReport",{"id":rowData.id}) ;

UserService
用户服务

属性：currentUser
作用：存储当前登录用户信息的对象

对象属性

account:string //账号
corpId: string //法人单位ID
createTime: string; //创建时间
creator: string; //创建人
creatorVer: number; //创建人版本号
id: string; //ID
isNew: number; //
jobsId: string //职位ID
modiTime: string; //更新时间
modiUser: string; //更新人
modiUserVer: number; //更新人版本号
orgId: string; //组织ID
realName: string; //名字
version: number; //版本

例子 ( 获取当前用户登录名称 )
 var name = this.UserService.currentUser. realName;

ConfirmationService
信息提示服务

方法：ConfirmationService.confirm(confirmation: Confirmation | string)
作用：弹窗提示信息

参数

confirmation 为string类型时：直接输入想要输出的 message

confirmation 为 Confirmation 对象时：需要传入一个对象 = {
message?: string; //显示的文本内容
icon?: string; //图标,success,warning,error,info
header?: string; //比较大的字
accept?: Function; //确定的回调方法
reject?: Function; //取消的回调方法
acceptVisible?: boolean; //是否显示确定按钮，默认显示
rejectVisible?: boolean; //是否显示取消按钮，默认不显示
largeMessage?:string; //是否包含大数据，有大数据的话，有下角增加个查看更多的按钮
acceptEvent?: EventEmitter<any>;
rejectEvent?: EventEmitter<any>;
}

例子

// 参数为 string 类型  
this.ConfirmationService.confirm('保存成功');
// 参数为Confirmation 对象 
this.ConfirmationService.confirm({
   message: '是否保存？',
   icon:"info",
   rejectVisible:true,
   accept: () => this.HttpService.post("请求地址",params)
       .subscribe((res)=>{
      });
  },
 reject: () => {
     // 取消操作
  }
});

AuthGuardService
用户没登录的情况下就跳转去登录页面的服务

方法：AuthGuardService.checkLogin(url)
作用：用户没登录的情况下就跳转去登录页面

参数

url ：用户尝试访问的路径

例子

// 参数为 string 类型  
this.AuthGuardService.checkLogin('/main/fly_message/message-detail');

TranslateService
多语言翻译服务

属性：onLangChange
作用：监听语言变化的事件

例子

 this.TranslateService.onLangChange.subscribe((event: LangChangeEvent) => {
     // console.log("可以看看里面是什么东西",event);
 });

属性：onTranslationChange
作用：监听翻译变化的事件

例子

 this.TranslateService.onTranslationChange.subscribe((event: TranslationChangeEvent) => {
     // console.log("可以看看里面是什么东西",event);
 });

属性：onDefaultLangChange
作用：监听默认语言改变的事件

例子

 this.TranslateService.onDefaultLangChange.subscribe((event: DefaultLangChangeEvent) => {
     // console.log("可以看看里面是什么东西",event);
 });

方法：setDefaultLang(lang: string)
作用：设置默认语言

参数

lang ：设置的语言

例子

this.TranslateService.setDefaultLang('设置的语言类型');

方法：getDefaultLang()
作用：获取当前默认语言

例子

var lang = this.TranslateService.getDefaultLang();

方法：use(lang: string)
作用：改变当前使用的语言

参数

lang ：设置的语言

例子

this.TranslateService.use(lang);

方法：getLangs()
作用：返回当前可用的语言集合

例子

var lang = this.TranslateService.getLangs();

方法：get(key: string|Array<string>, interpolateParams?: Object)
作用：获取键的翻译值或者对应键

参数

key ：想要翻译的字段的key值

例子

var value = this.TranslateService.get(key);

方法：set(key: string, value: string, lang?: string)
作用：设置某个键的翻译值

参数

key ：翻译某个键的key值

value ：翻译某个键的value值

lang ：该键的翻译值保存到的语言，如果为空则默认保存到当前语言

例子

this.TranslateService.set(key,value,lang);

方法：reloadLang(lang: string)
作用：执行resetLang(lang: string)并且恢复/找回翻译对象给当前加载器

参数

lang ：重新加载某个语言

例子

this.TranslateService.reloadLang(lang);

方法：resetLang(lang: string)
作用：移除某语言的翻译值。你必须重新去使用use，reloadLang或者getTranslation方法去使得它能重新翻译

参数

lang ：想要移除的语言

例子

this.TranslateService.resetLang(lang);

方法：getBrowserLang()
作用：如果未定义默认语言并且浏览器允许，则返回浏览器当前语言

例子

var lang = this.TranslateService.getBrowserLang();

方法：getBrowserCultureLang()
作用：如果未定义默认语言并且浏览器允许，则返回浏览器当前文化语言名称

例子

var lang = this.TranslateService.getBrowserCultureLang();

LocalStorageService
本地缓存（浏览器有效）

方法：SessionStorageService.store(key: string, value: any)
作用：将数据保存到缓存中

参数

key ：缓存数据的key值

value ：缓存数据

例子

this.SessionStorageService.store(key,value);

方法：SessionStorageService.retrieve(key: string)
作用：根据key值查询缓存数据

参数

key ：缓存数据的key值

例子

var list = this.SessionStorageService.retrieve(key);

方法：SessionStorageService.clear()
作用：清理缓存数据

例子

this.SessionStorageService.clear();

SessionStorageService
本地缓存（当前窗口有效）

方法：SessionStorageService.store(key: string, value: any)
作用：将数据保存到缓存中

参数

key ：缓存数据的key值

value ：缓存数据

例子

this.SessionStorageService.store(key,value);

方法：SessionStorageService.retrieve(key: string)
作用：根据key值查询缓存数据

参数

key ：缓存数据的key值

例子

var list = this.SessionStorageService.retrieve(key);

方法：SessionStorageService.clear()
作用：清理缓存数据

例子

this.SessionStorageService.clear();

InteractionService
与手机端交互的服务

方法：InteractionService.contact(appTriggerCode:string,appCallbackCode:string,callback:Function)
作用：调用手机端的某个服务

参数

appTriggerCode ：手机端执行相应动作的代码

appCallbackCode ：手机端完成动作后返回的值

callback ：接收到手机返回值后执行的方法

例子

// 手机端扫描方法  
this.InteractionService.contact("scan#A$#","onScanResult",callback);

FlyReportService
报表服务

方法：fetchPrintInfo(moduleCode:string,dirCode)
作用：获取目录下所有报表的信息

参数

moduleCode ：模块编码

dirCode ：目录编码

例子

var list = this.FlyReportService.fetchPrintInfo(moduleCode,dirCode);

方法：canPrintReport(routerPath:string)
作用：判断页面能不能打印报表

参数

routerPath ：页面路由

例子

this.FlyReportService.canPrintReport(routerPath:string);

方法：fgetReportCodeByRouterPath(routerPath:string)
作用：根据路由获取报表编码

参数

routerPath ：页面路由

例子

this.FlyReportService.fgetReportCodeByRouterPath(routerPath:string);

方法：showCondition(reportCode,type,conditionValues?:any)
作用：显示报表

参数

reportCode ：报表编码

type ：类型

conditionValues ：报表条件的默认值,一般是主对象的数据

例子

this.FlyReportService.showCondition(reportCode,type,conditionValues);

FormValidationService
表单验证服务

方法：check(form:NgForm)
作用：检查表单是否通过，不通过的就标记

参数

form：页面表单

例子

this.FormValidationService.check(this.form);

方法：focusFirstInvalid()
作用：聚焦到第一个无效的节点

例子

this.FormValidationService.focusFirstInvalid()

SimpleUUIDService
简单的UUID服务（解决ngModel重复的问题）

方法：generateUUID()
作用：生成唯一的id，从1开始

例子

var str = this.SimpleUUIDService.generateUUID();

方法：restoreUUID(uuid:number)
作用：回收UUID

参数

uuid : UUID

例子

this.SimpleUUIDService.restoreUUID(uuid);

网友评论

本文标题：服务API

本文链接：https://www.haomeiwen.com/subject/uibtrxtx.html

延伸阅读

深度阅读

您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

服务API

HttpService

方法：HttpService.post(url,params,options)

参数

例子

方法：HttpService.downLoadFile(url,params)

参数

例子

UserService

属性：currentUser

对象属性

例子 ( 获取当前用户登录名称 )

ConfirmationService

方法：ConfirmationService.confirm(confirmation: Confirmation | string)

参数

例子

AuthGuardService

方法：AuthGuardService.checkLogin(url)

参数

例子

TranslateService

属性：onLangChange

例子

属性：onTranslationChange

例子

属性：onDefaultLangChange

例子

方法：setDefaultLang(lang: string)

参数

例子

方法：getDefaultLang()

例子

方法：use(lang: string)

参数

例子

方法：getLangs()

例子

方法：get(key: string|Array<string>, interpolateParams?: Object)

参数

例子

方法：set(key: string, value: string, lang?: string)

参数

例子

方法：reloadLang(lang: string)

参数

例子

方法：resetLang(lang: string)

参数

例子

方法：getBrowserLang()

例子

方法：getBrowserCultureLang()

例子

LocalStorageService

方法：SessionStorageService.store(key: string, value: any)

参数

例子

方法：SessionStorageService.retrieve(key: string)

参数

例子

方法：SessionStorageService.clear()

例子

SessionStorageService

方法：SessionStorageService.store(key: string, value: any)

参数

例子

方法：SessionStorageService.retrieve(key: string)

参数

例子

方法：SessionStorageService.clear()

例子

InteractionService

方法：InteractionService.contact(appTriggerCode:string,appCallbackCode:string,callback:Function)

参数

例子

FlyReportService

方法：fetchPrintInfo(moduleCode:string,dirCode)

参数

例子

方法：canPrintReport(routerPath:string)

方法：`HttpService.post(url,params,options)`

方法：`HttpService.downLoadFile(url,params)`

属性：`currentUser`

方法：`ConfirmationService.confirm(confirmation: Confirmation | string)`

方法：`AuthGuardService.checkLogin(url)`

属性：`onLangChange`

属性：`onTranslationChange`

属性：`onDefaultLangChange`

方法：`setDefaultLang(lang: string)`

方法：`getDefaultLang()`

方法：`use(lang: string)`

方法：`getLangs()`

方法：`get(key: string|Array<string>, interpolateParams?: Object)`

方法：`set(key: string, value: string, lang?: string)`

方法：`reloadLang(lang: string)`

方法：`resetLang(lang: string)`

方法：`getBrowserLang()`

方法：`getBrowserCultureLang()`

方法：`SessionStorageService.store(key: string, value: any)`

方法：`SessionStorageService.retrieve(key: string)`

方法：`SessionStorageService.clear()`

方法：`SessionStorageService.store(key: string, value: any)`

方法：`SessionStorageService.retrieve(key: string)`

方法：`SessionStorageService.clear()`

方法：`InteractionService.contact(appTriggerCode:string,appCallbackCode:string,callback:Function)`

方法：`fetchPrintInfo(moduleCode:string,dirCode)`

方法：`canPrintReport(routerPath:string)`

方法：`fgetReportCodeByRouterPath(routerPath:string)`

方法：`showCondition(reportCode,type,conditionValues?:any)`

方法：`check(form:NgForm)`

方法：`focusFirstInvalid()`

方法：`generateUUID()`

方法：`restoreUUID(uuid:number)`