class ApiScope
cangjie
public class ApiScope <: ResourceBase & IScope & Serializable<ApiScope>功能:表示可供客户端申请的 API 作用域。
父类型:
- ResourceBase
- IScope
- Serializable<ApiScope>
成员概览
| 成员 | 功能 |
|---|---|
| init() | 创建空的 API 作用域实例。 |
| init(String) | 使用作用域名称创建 API 作用域。 |
| init(String, ?String) | 使用名称和描述创建 API 作用域。 |
| var required | 标识当前作用域是否必须被显式授予。 |
| func serialize() | 将当前 API 作用域序列化为数据模型。 |
| func deserialize(DataModel) | 从数据模型反序列化 API 作用域。 |
init()
cangjie
public init()功能:创建空的 API 作用域实例。
init(String)
cangjie
public init(name: String)功能:使用作用域名称创建 API 作用域。
参数:
- name:
String- 作用域名称。
init(String, ?String)
cangjie
public init(name: String, description: ?String)功能:使用名称和描述创建 API 作用域。
参数:
- name:
String- 作用域名称。 - description:
?String- 作用域描述。
var required
cangjie
public var required = false功能:标识当前作用域是否必须被显式授予。
func serialize()
cangjie
public func serialize(): DataModelStruct功能:将当前 API 作用域序列化为数据模型。
返回值:
DataModelStruct- 返回 API 作用域对应的数据模型结构。
func deserialize(DataModel)
cangjie
public static func deserialize(dm: DataModel): ApiScope功能:从数据模型反序列化 API 作用域。
参数:
- dm:
DataModel- API 作用域对应的数据模型。
返回值:
- ApiScope - 返回反序列化后的 API 作用域。
异常:
DataModelException- 当数据模型不是结构类型时抛出。