ZhiYeJianKang_PeiXun/Song.Site/bin/Song.ViewData.xml
2025-02-20 15:41:53 +08:00

1469 lines
54 KiB
XML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0"?>
<doc>
<assembly>
<name>Song.ViewData</name>
</assembly>
<members>
<member name="T:Song.ViewData.Attri.CacheAttribute">
<summary>
方法是否支持缓存
</summary>
</member>
<member name="P:Song.ViewData.Attri.CacheAttribute.Expires">
<summary>
失效时间
</summary>
</member>
<member name="M:Song.ViewData.Attri.CacheAttribute.GetResult(System.Reflection.MethodInfo,Song.ViewData.Letter)">
<summary>
获取缓存
</summary>
<param name="method"></param>
<param name="letter"></param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Attri.CacheAttribute.Remove(System.Reflection.MethodInfo,Song.ViewData.Letter)">
<summary>
移除和某个缓存
</summary>
<param name="method"></param>
<param name="letter"></param>
</member>
<member name="M:Song.ViewData.Attri.CacheAttribute.Insert(System.Int32,System.Reflection.MethodInfo,Song.ViewData.Letter,System.Object)">
<summary>
创建缓存
</summary>
<param name="expires"></param>
<param name="method"></param>
<param name="letter"></param>
<param name="result"></param>
</member>
<member name="T:Song.ViewData.Attri.MobileAttribute">
<summary>
限制仅限手机端使用
</summary>
</member>
<member name="T:Song.ViewData.Attri.WebAttribute">
<summary>
限制电脑端网页使用
</summary>
</member>
<member name="T:Song.ViewData.Attri.DesktopAttribute">
<summary>
电脑桌面应用使用
</summary>
</member>
<member name="T:Song.ViewData.Attri.WeixinAttribute">
<summary>
限制微信使用
</summary>
</member>
<member name="T:Song.ViewData.Attri.TVAttribute">
<summary>
智能电视使用
</summary>
</member>
<member name="T:Song.ViewData.Attri.ClientAttribute">
<summary>
客户端的使用限制
</summary>
</member>
<member name="T:Song.ViewData.Attri.SuperAdminAttribute">
<summary>
必须是超级管理员登录后才能操作
</summary>
</member>
<member name="M:Song.ViewData.Attri.SuperAdminAttribute.Logged">
<summary>
超级管理员是否登录
</summary>
<returns></returns>
</member>
<member name="T:Song.ViewData.Attri.DomainAttribute">
<summary>
限制请求必须来自根域
</summary>
</member>
<member name="T:Song.ViewData.Attri.LocalhostAttribute">
<summary>
限制请求必须来自本机
</summary>
</member>
<member name="T:Song.ViewData.Attri.IntranetAttribute">
<summary>
限制请求必须来局域网
</summary>
</member>
<member name="T:Song.ViewData.Attri.AnywhereAttribute">
<summary>
任何地方的请求都可以通过
</summary>
</member>
<member name="T:Song.ViewData.Attri.HttpAttribute">
<summary>
HTTP谓词限制特性的父类
</summary>
</member>
<member name="M:Song.ViewData.Attri.HttpAttribute.Verify(System.String,System.Reflection.MemberInfo)">
<summary>
验证是否满足特性的限定
</summary>
<param name="httpmethod">http请求方法即谓词</param>
<param name="method">执行的方法</param>
<returns></returns>
</member>
<member name="T:Song.ViewData.Attri.AdminAttribute">
<summary>
设置方法是否需要管理员登录后执行
</summary>
</member>
<member name="M:Song.ViewData.Attri.AdminAttribute.Logged">
<summary>
是否登录
</summary>
<returns></returns>
</member>
<member name="T:Song.ViewData.Attri.StudentAttribute">
<summary>
必须是学员登录后才能调用
</summary>
</member>
<member name="M:Song.ViewData.Attri.StudentAttribute.Logged">
<summary>
是否登录
</summary>
<returns></returns>
</member>
<member name="T:Song.ViewData.Attri.TeacherAttribute">
<summary>
必须是教师登录后才能调用
</summary>
</member>
<member name="M:Song.ViewData.Attri.TeacherAttribute.Logged">
<summary>
是否登录
</summary>
<returns></returns>
</member>
<member name="T:Song.ViewData.Attri.LoginAttribute">
<summary>
登录属性验证的父类
验证方法:
1、如果类加了特性则类下所有方法必须登录才能调用除非方法特性有Ignore=true;
2、如果类加了特性且Ignore=true则类下所有方法都可以调即便方法添加特性用Ignore=false
3、如果类没有加特性但方法加了特性则必须登录才能调用
</summary>
</member>
<member name="M:Song.ViewData.Attri.LoginAttribute.Logged">
<summary>
是否登录
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.Attri.LoginAttribute.LogWrite(Song.ViewData.Attri.LoginAttribute,System.Object)">
<summary>
将执行结果写入日志
</summary>
<param name="attr"></param>
<param name="execResult"></param>
</member>
<member name="M:Song.ViewData.Attri.LoginAttribute.Verify(System.Reflection.MemberInfo)">
<summary>
验证是否满足特性的限定
</summary>
<param name="method">执行的方法</param>
<returns></returns>
</member>
<member name="T:Song.ViewData.Attri.PurviewAttribute">
<summary>
权限验证
</summary>
</member>
<member name="P:Song.ViewData.Attri.PurviewAttribute.Ignore">
<summary>
忽略此方法默认为false
说明:则某个类设置了特性后,下面的所有方法都需要验证,除非设置[Admin(Ignore=true)]
</summary>
</member>
<member name="M:Song.ViewData.Attri.PurviewAttribute.Logged">
<summary>
是否登录
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.Attri.PurviewAttribute.LogWrite(System.Object)">
<summary>
将执行结果写入日志
</summary>
<param name="execResult"></param>
</member>
<member name="T:Song.ViewData.Attri.StudyAttribute">
<summary>
学员能够学习当前课程,才能使用的方法
</summary>
</member>
<member name="T:Song.ViewData.Attri.BuyAttribute">
<summary>
学员购买课程后才能使用的方法
</summary>
</member>
<member name="T:Song.ViewData.Attri.RangeAttribute">
<summary>
请求的区间限制
</summary>
</member>
<member name="M:Song.ViewData.Attri.RangeAttribute.Verify(Song.ViewData.Letter,System.Reflection.MemberInfo)">
<summary>
验证是否满足特性的限定
</summary>
<param name="letter">请求</param>
<param name="method">执行的方法</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Attri.RangeAttribute.LogWrite(System.Object)">
<summary>
将执行结果写入日志
</summary>
<param name="execResult"></param>
</member>
<member name="P:Song.ViewData.Attri.WeishaAttr.Ignore">
<summary>
忽略此方法默认为false
说明:则某个类设置了特性后,下面的所有方法都需要验证,除非设置[Admin(Ignore=true)]
</summary>
</member>
<member name="M:Song.ViewData.Attri.WeishaAttr.GetAttr``1(System.Reflection.MemberInfo)">
<summary>
获取方法的某一类特性
</summary>
<param name="method">要验证的方法</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Attri.WeishaAttr.GetAttrs``1(System.Reflection.MemberInfo)">
<summary>
获取方法的特性
</summary>
<param name="method">要验证的方法</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Attri.WeishaAttr.Initialization">
<summary>
初始化,获取所有特性
</summary>
</member>
<member name="T:Song.ViewData.DataResult">
<summary>
当客户端请求Song.ViewData方法时返回值全部用该方法“包装”方便返回json或xml格式数据
如果是服务器端方法,则无须“包装”
</summary>
</member>
<member name="P:Song.ViewData.DataResult.Success">
<summary>
是否成功
</summary>
</member>
<member name="P:Song.ViewData.DataResult.Message">
<summary>
消息
</summary>
</member>
<member name="P:Song.ViewData.DataResult.State">
<summary>
状态码
</summary>
</member>
<member name="P:Song.ViewData.DataResult.DateTime">
<summary>
执行时间
</summary>
</member>
<member name="P:Song.ViewData.DataResult.ExecSpan">
<summary>
执行耗时(单位:毫秒)
</summary>
</member>
<member name="P:Song.ViewData.DataResult.WebSpan">
<summary>
web端执行耗时单位毫秒
</summary>
</member>
<member name="P:Song.ViewData.DataResult.Timestamp">
<summary>
执行时间的时间戳
</summary>
</member>
<member name="P:Song.ViewData.DataResult.Exception">
<summary>
详细的异常信息
</summary>
</member>
<member name="P:Song.ViewData.DataResult.Result">
<summary>
实际返回的数据
</summary>
</member>
<member name="M:Song.ViewData.DataResult.#ctor">
<summary>
</summary>
</member>
<member name="M:Song.ViewData.DataResult.#ctor(System.Object)">
<summary>
构造方法
</summary>
<param name="obj"></param>
</member>
<member name="M:Song.ViewData.DataResult.#ctor(System.Exception,System.DateTime)">
<summary>
</summary>
<param name="exc"></param>
</member>
<member name="M:Song.ViewData.DataResult.#ctor(System.Object,System.Exception)">
<summary>
</summary>
<param name="obj"></param>
<param name="exc"></param>
</member>
<member name="M:Song.ViewData.DataResult.ToJson">
<summary>
输出Json字符串
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.DataResult._json_property(System.String,System.Object)">
<summary>
为json输出字段
</summary>
<param name="typename">字段的类型名称</param>
<param name="value">字段的值</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.DataResult.ToXml">
<summary>
输出XML字符串
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.DataResult._xml_property(System.String,System.Object)">
<summary>
为xml输出字段
</summary>
<param name="typename">字段的类型名称</param>
<param name="value">字段的值</param>
<returns></returns>
</member>
<member name="T:Song.ViewData.ExecuteMethod">
<summary>
执行具体的方法
</summary>
</member>
<member name="M:Song.ViewData.ExecuteMethod.GetInstance">
<summary>
返回实例
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.ExecuteMethod.CreateInstance(Song.ViewData.Letter)">
<summary>
创建对象,如果存在,则直接返回;如果不存在,创建后返回
</summary>
<param name="letter"></param>
<returns></returns>
</member>
<member name="M:Song.ViewData.ExecuteMethod.Exec(Song.ViewData.Letter)">
<summary>
执行,按实际结果返回
</summary>
<param name="letter">客户端递交的参数信息</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.ExecuteMethod.ExecToResult(Song.ViewData.Letter)">
<summary>
执行返回结构封装到DataResult对象中
</summary>
<param name="letter">客户端递交的参数信息</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.ExecuteMethod.getMethod(System.Type,Song.ViewData.Letter)">
<summary>
要执行的方法,根据方法名、参数数量
</summary>
<param name="type">要调用的对象的类型</param>
<param name="p"></param>
<returns></returns>
</member>
<member name="M:Song.ViewData.ExecuteMethod.getInvokeParam(System.Reflection.MethodInfo,Song.ViewData.Letter)">
<summary>
返回方法执行所需要的参数
</summary>
<param name="method">要执行的方法</param>
<param name="letter">传递来的参数</param>
<returns></returns>
</member>
<member name="T:Song.ViewData.Browser">
<summary>
浏览器信息
</summary>
</member>
<member name="P:Song.ViewData.Browser.IsMobile">
<summary>
当前浏览器是否是手机浏览器
</summary>
</member>
<member name="P:Song.ViewData.Browser.IsWeixin">
<summary>
当前浏览器是否是微信浏览器
</summary>
</member>
<member name="P:Song.ViewData.Browser.IsWeixinApp">
<summary>
前端浏览器是否是微信小程序
</summary>
</member>
<member name="P:Song.ViewData.Browser.IsDestopApp">
<summary>
前端浏览器是否是桌面应用
</summary>
</member>
<member name="P:Song.ViewData.Browser.IsAPICloud">
<summary>
是否处于Apicloud打包的APP中
</summary>
</member>
<member name="P:Song.ViewData.Browser.IsIPhone">
<summary>
当前浏览器是否来自苹果手机
</summary>
</member>
<member name="P:Song.ViewData.Browser.IP">
<summary>
客户端IP
</summary>
</member>
<member name="M:Song.ViewData.Browser.IsIPAddress(System.String)">
<summary>
判断是否是IP地址格式 0.0.0.0
</summary>
<param name="str1">待判断的IP地址</param>
<returns>true or false</returns>
</member>
<member name="P:Song.ViewData.Browser.Type">
<summary>
客户端的浏览器类型
</summary>
</member>
<member name="P:Song.ViewData.Browser.Name">
<summary>
客户端的浏览器的名称
</summary>
</member>
<member name="P:Song.ViewData.Browser.Version">
<summary>
客户端的浏览器的版本号
</summary>
</member>
<member name="P:Song.ViewData.Browser.OS">
<summary>
获取客户端的操作系统名称
</summary>
</member>
<member name="P:Song.ViewData.Browser.MobileOS">
<summary>
获取手机操作系统;
</summary>
</member>
<member name="P:Song.ViewData.Browser.PhoneNumber">
<summary>
获取手机号码(如果是手机访问),但是大多数通信商受限,无法获取
</summary>
</member>
<member name="T:Song.ViewData.Helper.Admin">
<summary>
管理员登录状态的管理对象
</summary>
</member>
<member name="P:Song.ViewData.Helper.Admin.Singleton">
<summary>
获取参数
</summary>
</member>
<member name="P:Song.ViewData.Helper.Admin.LoginPattern">
<summary>
后台管理登录的状态管理方式值为Cookies或Session
</summary>
</member>
<member name="P:Song.ViewData.Helper.Admin.OnlineUser">
<summary>
在线用户
</summary>
</member>
<member name="P:Song.ViewData.Helper.Admin.Key">
<summary>
用于存储Cookie或Session的key
</summary>
</member>
<member name="P:Song.ViewData.Helper.Admin.Value">
<summary>
存储于Cookie或Session的值
</summary>
</member>
<member name="P:Song.ViewData.Helper.Admin.Expires">
<summary>
Cookie或Session的时效单位为分钟
</summary>
</member>
<member name="P:Song.ViewData.Helper.Admin.UserID">
<summary>
当前登录用户的id
</summary>
</member>
<member name="P:Song.ViewData.Helper.Admin.CurrentUser">
<summary>
返回当前登录用户的实体
</summary>
<returns></returns>
</member>
<member name="P:Song.ViewData.Helper.Admin.IsSuperAdmin">
<summary>
当前登录用户是否为超级管理员
</summary>
</member>
<member name="M:Song.ViewData.Helper.Admin.EncryptForDES(System.Int32)">
<summary>
加密要写入的内容
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Helper.Admin.Write(Song.Entities.EmpAccount)">
<summary>
将已经登录入的用户写入seesion或cookies
</summary>
<param name="acc"></param>
</member>
<member name="M:Song.ViewData.Helper.Admin.Write(Song.Entities.EmpAccount,System.String)">
<summary>
将已经登录入的用户写入seesion或cookies
</summary>
<param name="acc"></param>
<param name="twoDomain">机构的二级域名如果没有则用机构id</param>
</member>
<member name="M:Song.ViewData.Helper.Admin.Write">
<summary>
写入当前用户
</summary>
</member>
<member name="M:Song.ViewData.Helper.Admin.Register(Song.Entities.EmpAccount)">
<summary>
注册某个用户到在线列表中
</summary>
<param name="acc"></param>
</member>
<member name="M:Song.ViewData.Helper.Admin.Logout">
<summary>
注销当前用户
</summary>
</member>
<member name="M:Song.ViewData.Helper.Admin.CleanOut">
<summary>
清理超时用户
</summary>
</member>
<member name="T:Song.ViewData.Helper.LoginPatternEnum">
<summary>
登录状态方式的枚举
</summary>
</member>
<member name="T:Song.ViewData.ConvertToAnyValue">
<summary>
将某个值转换为任意数据类型
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.ParaValue">
<summary>
参数的原始值
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.ParaKey">
<summary>
参数的键名
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.Unit">
<summary>
参数的单位
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.Int16">
<summary>
参数的Int16类型值如果参数不存在或异常则返回null;
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.Int32">
<summary>
参数的Int32类型值如果参数不存在或异常则返回null;
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.Int64">
<summary>
参数的Int64类型值如果参数不存在或异常则返回null;
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.Double">
<summary>
参数的Double类型值如果参数不存在或异常则返回null;
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.String">
<summary>
参数的String类型值如果参数不存在或异常则返回空字符串非Null;
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.Text">
<summary>
参数文本类型值自动去除html标签
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.Value">
<summary>
参数的值,如果没有内容返回Null
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.Boolean">
<summary>
参数的Boolean类型值如果参数不存在或异常则返回true;
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.DateTime">
<summary>
参数的DateTime类型值如果参数不存在或异常则返回null;
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.MD5">
<summary>
参数的MD5加密值(小写)如果参数不存在或异常则返回null;
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.SHA1">
<summary>
参数的SHA1加密值如果参数不存在或异常则返回null;
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.UrlDecode">
<summary>
参数的字符串进行 URL 解码并返回已解码的字符串。如果参数不存在或异常则返回null;
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.HtmlDecode">
<summary>
对经过HTML 编码的参数进行解码并返回已解码的字符串。如果参数不存在或异常则返回null;
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.MapPath">
<summary>
转换为物理路径
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.VirtualPath">
<summary>
转换虚拟路径
</summary>
</member>
<member name="M:Song.ViewData.ConvertToAnyValue.Split(System.Char)">
<summary>
将字符串分拆成数组
</summary>
<param name="split">用于分拆的字符</param>
<returns></returns>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.JavascriptTime">
<summary>
将C#时间转换成Javascript的时间
</summary>
</member>
<member name="P:Song.ViewData.ConvertToAnyValue.TimeStamp">
<summary>
JavaScript时间戳是指格林威治时间1970年01月01日00时00分00秒(北京时间1970年01月01日08时00分00秒)起至现在的总毫秒数。
</summary>
</member>
<member name="M:Song.ViewData.ConvertToAnyValue.ChangeType(System.Type)">
<summary>
转为指定的数据库类型
</summary>
<param name="type"></param>
<returns></returns>
</member>
<member name="M:Song.ViewData.ConvertToAnyValue.Decrypt">
<summary>
解密字符串,默认密钥为当前域名
</summary>
<returns></returns>
</member>
<member name="T:Song.ViewData.Server">
<summary>
服务器信息
</summary>
</member>
<member name="P:Song.ViewData.Server.IP">
<summary>
服务器IP
</summary>
</member>
<member name="P:Song.ViewData.Server.IsLocalIP">
<summary>
是否是本机IP
</summary>
</member>
<member name="P:Song.ViewData.Server.IsIntranetIP">
<summary>
是否是内网IP
</summary>
</member>
<member name="P:Song.ViewData.Server.Port">
<summary>
服务器访问端口
</summary>
</member>
<member name="P:Song.ViewData.Server.Domain">
<summary>
站点的访问域名
</summary>
<returns></returns>
</member>
<member name="P:Song.ViewData.Server.RootDomain">
<summary>
db.config中配置的根域
</summary>
</member>
<member name="P:Song.ViewData.Server.DomainPath">
<summary>
站点的访问域名带端口,如:http://www.xx.com/
</summary>
<returns></returns>
</member>
<member name="P:Song.ViewData.Server.OS">
<summary>
服务器操作系统
</summary>
</member>
<member name="P:Song.ViewData.Server.IISVersion">
<summary>
IIS版本
</summary>
</member>
<member name="P:Song.ViewData.Server.CPUCount">
<summary>
CPU个数
</summary>
</member>
<member name="P:Song.ViewData.Server.CPUHz">
<summary>
CPU主频单位 GHz
</summary>
</member>
<member name="P:Song.ViewData.Server.RamSize">
<summary>
物理内存大小
</summary>
</member>
<member name="P:Song.ViewData.Server.DotNetVersion">
<summary>
.Net FramwWork版本号
</summary>
</member>
<member name="P:Song.ViewData.Server.CPU_ID">
<summary>
获取CPU的序列号由于某些原因可能获取不到
</summary>
</member>
<member name="P:Song.ViewData.Server.ProgramPath">
<summary>
当前应用程序的物理路径
</summary>
</member>
<member name="P:Song.ViewData.Server.InitDate">
<summary>
系统部署运行的初始时间
</summary>
</member>
<member name="T:Song.ViewData.IViewAPI">
<summary>
所有通够通过api请求的对象必须继承自该接口
该接没没有任何方法,仅作为标识
</summary>
</member>
<member name="T:Song.ViewData.Letter">
<summary>
记录客户端递交来的信息
</summary>
</member>
<member name="P:Song.ViewData.Letter.HTTP_METHOD">
<summary>
HTTP请求谓词即Get、Post、Put等
</summary>
</member>
<member name="P:Song.ViewData.Letter.HTTP_REFERER">
<summary>
来源页一般是调用api方法时的所在页
</summary>
</member>
<member name="P:Song.ViewData.Letter.HTTP_HOST">
<summary>
http请求的域名
</summary>
</member>
<member name="P:Song.ViewData.Letter.HTTP_Mark">
<summary>
请求标识只允许是weishakeji
</summary>
</member>
<member name="P:Song.ViewData.Letter.ReturnType">
<summary>
返回数据的类型默认为json可以设置为xml
</summary>
</member>
<member name="P:Song.ViewData.Letter.Version">
<summary>
接口版本
</summary>
</member>
<member name="P:Song.ViewData.Letter.ClassName">
<summary>
所请求接口的类名称
</summary>
</member>
<member name="P:Song.ViewData.Letter.MethodName">
<summary>
所请求接口的方法
</summary>
</member>
<member name="P:Song.ViewData.Letter.ID">
<summary>
id参数id是作为普通参数因为常用所以单独列出
</summary>
</member>
<member name="P:Song.ViewData.Letter.Params">
<summary>
参数集包括Get和Post即地址栏参数和form参数
如果参数名称有重名,后者会替换前者的值
</summary>
</member>
<member name="P:Song.ViewData.Letter.Cookies">
<summary>
Cookies参数集
</summary>
</member>
<member name="P:Song.ViewData.Letter.Sever">
<summary>
服务器端的信息
</summary>
</member>
<member name="P:Song.ViewData.Letter.Client">
<summary>
请求的来源,即客户端
</summary>
</member>
<member name="M:Song.ViewData.Letter.#ctor(System.Net.Http.HttpRequestMessage)">
<summary>
构造函数来自MVC控制器的调用客户端采用$api时会经过MVC控制器
通过此种方式会获取get、post参数并从当前线程获取cookies集合
</summary>
<param name="httprequest">api控制器的访问对象</param>
</member>
<member name="M:Song.ViewData.Letter.#ctor(System.String,System.String)">
<summary>
构造方法,直接用字符串传递参数,服务器端@Api调用时用此方法
通过此种方式利用参数2string paramseters解析所需参数并从当前线程获取cookies集合
</summary>
<param name="method">格式:类名/方法名</param>
<param name="paramseters">格式:"p1:str,p2:str"</param>
</member>
<member name="P:Song.ViewData.Letter.Item(System.String)">
<summary>
获取参数的值等同GetParameter(string key)方法
</summary>
<param name="key">参数名</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Letter.GetParameter(System.String)">
<summary>
获取参数值
</summary>
<param name="key">参数名</param>
<returns>参数Value值</returns>
</member>
<member name="M:Song.ViewData.Letter.ExistParameter(System.String)">
<summary>
是否存在某参数
</summary>
<param name="key">参数的Key值</param>
<returns>参数Value值</returns>
</member>
<member name="M:Song.ViewData.Letter.GetCookie(System.String)">
<summary>
获取cookie值
</summary>
<param name="key">cookie名称</param>
<returns>cookie的值</returns>
</member>
<member name="M:Song.ViewData.Letter.ToString">
<summary>
重写ToString方法将参数串连成字符串
</summary>
<returns>格式key=value;</returns>
</member>
<member name="M:Song.ViewData.Letter.GetEnumerator">
<summary>
迭代器
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.Letter.Convert``1">
<summary>
将参数转换为其它类型,常见转换成实体
</summary>
<typeparam name="T"></typeparam>
<returns></returns>
</member>
<member name="T:Song.ViewData.ListResult">
<summary>
当请求的Song.ViewData方法是列表时尤其是分页数据时用该方法“包装”
不管是服务端还是客户端,都要用此方法“包装”
</summary>
</member>
<member name="P:Song.ViewData.ListResult.Total">
<summary>
数据项的总数
</summary>
</member>
<member name="P:Song.ViewData.ListResult.Size">
<summary>
当前页的数据项个数
</summary>
</member>
<member name="P:Song.ViewData.ListResult.TotalPages">
<summary>
总页数
</summary>
</member>
<member name="P:Song.ViewData.ListResult.Index">
<summary>
当前页的索引起始为1
</summary>
</member>
<member name="M:Song.ViewData.ListResult.#ctor(System.Object)">
<summary>
构造方法
</summary>
<param name="obj"></param>
</member>
<member name="T:Song.ViewData.Methods.Account">
<summary>
管理账号
</summary>
</member>
<member name="M:Song.ViewData.Methods.Account.ForID(System.Int32)">
<summary>
根据ID查询学员账号
</summary>
<remarks>为了安全,返回的对象密码不显示</remarks>
<param name="id"></param>
<returns>学员账户的映射对象</returns>
</member>
<member name="M:Song.ViewData.Methods.Account.Current">
<summary>
当前登录的学员
</summary>
<remarks>登录状态通过cookies或session保持</remarks>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Account.ForAcc(System.String)">
<summary>
根据账号获取学员,不支持模糊查询
</summary>
<param name="acc">学员账号</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Account.ForName(System.String)">
<summary>
根据学员名称获取学员信息,支持模糊查询
</summary>
<param name="name">学员名称</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Account.Seach(System.String,System.String)">
<summary>
按账号和姓名查询学员
</summary>
<param name="acc">学员账号</param>
<param name="name">姓名,可模糊查询</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Account.ForLogs(System.String,System.String)">
<summary>
从学习记录中获取学员记录
</summary>
<param name="acc">学员账号</param>
<param name="name">学员姓名</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Account.StudyLog(System.Int32,System.Int32)">
<summary>
学员的视频学习记录
</summary>
<param name="acid">学员id</param>
<param name="couid">课程id</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Account.Pager(System.Int32,System.Int32)">
<summary>
分页获取学员信息
</summary>
<param name="index">页码,即第几页</param>
<param name="size">每页多少条记录</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Account._tran(Song.Entities.Accounts)">
<summary>
处理学员信息密码清空、头像转为全路径并生成clone对象
</summary>
<param name="acc">学员账户的clone对象</param>
<returns></returns>
</member>
<member name="T:Song.ViewData.Methods.Course">
<summary>
课程管理
</summary>
</member>
<member name="M:Song.ViewData.Methods.Course.ForID(System.Int32)">
<summary>
根据课程ID获取课程信息
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Course.Pager(System.Int32,System.String,System.String,System.Int32,System.Int32)">
<summary>
分页获取课程
</summary>
<param name="orgid">机构id</param>
<param name="sbjids">章节id可以为多个以逗号分隔</param>
<param name="search">检索字符,按课程名称</param>
<param name="size">每页几条</param>
<param name="index">第几页</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Course.StudyLog(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
记录当前学员的视频学习进度
</summary>
<param name="couid">课程ID</param>
<param name="olid">章节ID</param>
<param name="playTime">观看进度,单位:毫秒</param>
<param name="studyTime">学习时间,单位:秒</param>
<param name="totalTime">视频总时长,单位:秒</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Course._tran(Song.Entities.Course)">
<summary>
处理课程信息图片转为全路径并生成clone对象
</summary>
<param name="cour">课程对象的clone</param>
<returns></returns>
</member>
<member name="T:Song.ViewData.Methods.Live">
<summary>
直播
</summary>
</member>
<member name="M:Song.ViewData.Methods.Live.Setup(Song.ViewData.Letter)">
<summary>
记录直播的各种设置项
</summary>
<param name="letter"></param>
</member>
<member name="M:Song.ViewData.Methods.Live.GetSetup">
<summary>
获取设置项
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Live.Test(System.String,System.String,System.String)">
<summary>
测试链接是否通过
</summary>
<param name="ak">accesskey密钥</param>
<param name="sk">secretkey密钥</param>
<param name="hubname">直播空间名</param>
<returns></returns>
</member>
<member name="T:Song.ViewData.Methods.Organ">
<summary>
机构管理
</summary>
</member>
<member name="M:Song.ViewData.Methods.Organ.ForID(System.Int32)">
<summary>
通过机构id获取机构信息
</summary>
<param name="id">机构id</param>
<returns>机构实体</returns>
</member>
<member name="M:Song.ViewData.Methods.Organ.All">
<summary>
获取所有可用的机构
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Organ.Current">
<summary>
当前机构
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Organ._trans(Song.Entities.Organization)">
<summary>
处理机构对外展示的信息
</summary>
<param name="org"></param>
<returns></returns>
</member>
<member name="T:Song.ViewData.Methods.Outline">
<summary>
章节信息
</summary>
</member>
<member name="M:Song.ViewData.Methods.Outline.ForID(System.Int32)">
<summary>
获取章节
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Outline.List(System.Int32,System.Int32)">
<summary>
章节列表
</summary>
<param name="couid">所属课程的id</param>
<param name="pid">上级id</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Outline.Tree(System.Int32)">
<summary>
树形章节列表
</summary>
<param name="couid">所属课程的id</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Outline.Accessory(System.String)">
<summary>
章节附件
</summary>
<param name="oluid">章节的uid</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Outline.VideoEvents(System.Int32)">
<summary>
视频事件
</summary>
<param name="olid"></param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Outline.State(System.Int32)">
<summary>
章节的状态
</summary>
<param name="olid"></param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Outline.getDeskallow(Song.Entities.Course,Song.Entities.Outline,Song.Entities.Organization@)">
<summary>
判断是否必须在桌面应用中学习
</summary>
<returns>如果为true则必须在课面应用中学习</returns>
</member>
<member name="M:Song.ViewData.Methods.Outline.getSwitchPlay(Song.Entities.Course,Song.Entities.Accounts,Song.Entities.Organization)">
<summary>
判断当前课程是否允许切换浏览器时视频暂停
</summary>
<param name="course"></param>
<param name="acc"></param>
<param name="organ"></param>
<returns>true则允许浏览器失去焦点时视频仍然播放</returns>
</member>
<member name="T:Song.ViewData.Methods.Platform">
<summary>
平台信息
</summary>
</member>
<member name="M:Song.ViewData.Methods.Platform.Version">
<summary>
授权信息
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Platform.Copyright">
<summary>
版权信息来自根路径下的copyright.xml文件
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Platform.DbConnection">
<summary>
数据库是否链接正常
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Platform.DbVersion">
<summary>
数据库版本
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Platform.DbCheck">
<summary>
数据库字段与表是否完成
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Platform.Stamp">
<summary>
机构公章信息
</summary>
<returns>path:公章图片路径;positon:位置</returns>
</member>
<member name="T:Song.ViewData.Methods.Copyright_Item">
<summary>
版权信息的项
</summary>
</member>
<member name="T:Song.ViewData.Methods.Subject">
<summary>
专业管理
</summary>
</member>
<member name="M:Song.ViewData.Methods.Subject.ForID(System.Int32)">
<summary>
通过专业ID获取专业信息
</summary>
<param name="id">专业id</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Subject.List(System.Int32)">
<summary>
某个机构下的专业
</summary>
<param name="orgid">机构id</param>
<returns>专业列表</returns>
</member>
<member name="M:Song.ViewData.Methods.Subject.Tree(System.Int32)">
<summary>
某个机构下的专业
</summary>
<param name="orgid">机构id</param>
<returns>专业列表</returns>
</member>
<member name="M:Song.ViewData.Methods.Subject._tran(Song.Entities.Subject)">
<summary>
处理专业信息图片转为全路径并生成clone对象
</summary>
<param name="sbj">专业对象的clone</param>
<returns></returns>
</member>
<member name="T:Song.ViewData.Methods.Message">
<summary>
课程学习中的咨询留言,可作为弹幕
</summary>
</member>
<member name="M:Song.ViewData.Methods.Message.Add(System.String,System.String,System.Int32,System.Int32,System.Int32)">
<summary>
添加留言
</summary>
<param name="acc">学员账号,如果账号为空则默认为当前登录账号</param>
<param name="msg">留言信息</param>
<param name="playtime">视频播放时间</param>
<param name="couid">课程id</param>
<param name="olid">章节id</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Message.All(System.Int32,System.String)">
<summary>
获取章节的所有留言
</summary>
<param name="olid">章节id</param>
<param name="order">排序方式desc或asc</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Message.Count(System.Int32,System.String,System.Int32)">
<summary>
获取指定数量的留言
</summary>
<param name="olid">章节id</param>
<param name="order">排序方式desc或asc</param>
<param name="count">取多少条</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Message.Count(System.Int32,System.Int32)">
<summary>
获取留言数量
</summary>
<param name="couid">课程id</param>
<param name="olid">章节id</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Message.Pager(System.Int32,System.Int32,System.String,System.Int32,System.Int32)">
<summary>
分页获取留言信息
</summary>
<param name="couid">课程id</param>
<param name="olid">章节id</param>
<param name="search">检索</param>
<param name="size">当页多条记录</param>
<param name="index">第几页</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Message.Delete(System.Int32)">
<summary>
删除
</summary>
<param name="msid">留言id</param>
</member>
<member name="M:Song.ViewData.Methods.Message.Update(System.Int32,System.String)">
<summary>
更新留言内容
</summary>
<param name="msid">留言id</param>
<param name="msg">留言内容</param>
<returns></returns>
</member>
<member name="T:Song.ViewData.Methods.Teacher">
<summary>
教师账号的相关操作
</summary>
</member>
<member name="M:Song.ViewData.Methods.Teacher.Login(System.String,System.String)">
<summary>
教师登录
</summary>
<param name="acc">账号</param>
<param name="pw">密码,明文字符</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Teacher.Courses(System.Int32)">
<summary>
教师的课程
</summary>
<param name="thid">教师id</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Teacher.LiveCourses(System.Int32,System.Int32)">
<summary>
教师的直播课
</summary>
<param name="thid">教师id</param>
<param name="count">取多少条记录</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Teacher.Lives(System.Int32,System.Int32)">
<summary>
教师的直播章节
</summary>
<param name="thid">教师id</param>
<param name="couid">课程id</param>
<returns>返回内容包括带直播的章节的名称、ID、UID、课程名称、直播相关信息
LivePublish直播推流地址示例 rtmp://pili-publish.zhibo.weisha100.cn/ceshi5/132_267_548f3efe842b564c74babb4c70fc
LiveHLS播放地址示例 http://pili-live-hls.zhibo.weisha100.cn/ceshi5/132_267_548f3efe842b564c74babb4c70fc
LiveCover直播封面每五秒更新示例http://pili-snapshot.zhibo.weisha100.cn/ceshi5/132_267_548f3efe842b564c74babb4c70fc
LiveTime直播开始时间这个时间仅供于通知学员何时开始从技术来说直播可以随时开始
LiveSpan直播课的时长仅供告知学员课时长度从技术上来说直播不受时长限制
</returns>
<remarks></remarks>
</member>
<member name="T:Song.ViewData.Methods.Helper">
<summary>
接口方法的帮助
</summary>
</member>
<member name="M:Song.ViewData.Methods.Helper.List">
<summary>
接口方法列表
</summary>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Helper.Methods(System.String)">
<summary>
某个接口类下的方法
</summary>
<param name="classname">类名称</param>
<returns></returns>
<remarks>备注信息</remarks>
<example><![CDATA[
]]></example>
<exception cref="T:System.Exception">异常</exception>
</member>
<member name="M:Song.ViewData.Methods.Helper_API_Method_Para.GetParaString(System.Reflection.MethodInfo)">
<summary>
获取参数的类型,多个参数串连
</summary>
<param name="method"></param>
<returns></returns>
</member>
<member name="T:Song.ViewData.Methods.Student">
<summary>
学员管理,主要是学习情况等
</summary>
</member>
<member name="M:Song.ViewData.Methods.Student.All(System.String)">
<summary>
取所有学员
</summary>
<param name="sts">分组信息</param>
<returns></returns>
</member>
<member name="M:Song.ViewData.Methods.Student.CourseCompletion(System.Int32,System.String)">
<summary>
学员所学课程的完成度
</summary>
<param name="stid">学员账号id</param>
<param name="couid">课程id可以为多个(逗号分隔),可以为空</param>
<returns></returns>
</member>
<member name="T:Song.ViewData.ResultCache">
<summary>
API接口的返回结果的缓存
当参数名称一样,参数值一样时,采用缓存值
</summary>
</member>
<member name="T:Song.ViewData.VExcept">
<summary>
异常处理
</summary>
</member>
<member name="P:Song.ViewData.VExcept.State">
<summary>
状态码
</summary>
</member>
<member name="M:Song.ViewData.VExcept.Verify(System.String,System.Int32)">
<summary>
校验类实始状态码为10000
</summary>
<param name="msg"></param>
<param name="state"></param>
<returns></returns>
</member>
<member name="M:Song.ViewData.VExcept.System(System.String,System.Int32)">
<summary>
系统类错误
</summary>
<param name="msg"></param>
<param name="state"></param>
<returns></returns>
</member>
</members>
</doc>