Module service/access

Index

Enumerations

AccessCode

Interfaces

Access

Type aliases

Variables

Functions

Type aliases

AccessResult

AccessResult: { code: AccessCode; limitType: Access["LimitConfig"]; redirect?: string; success: boolean; text: string }

checkAccess的返回体

param text: AccessCodeText
param redirect: 重定向链接

Type declaration

code: AccessCode
limitType: Access["LimitConfig"]
Optional redirect?: string
success: boolean
text: string

AccessType

AccessType: "site" | "webinar" | "form" | "settings" | "landing" | "giftrepo" | "lottery" | "signInCode" | "system_document" | "system_video"

checkAccess的type

Variables

AccessCodeText

AccessCodeText: Record<AccessCode, string> = ...

AccessCode对应的文本描述

access

access: Record<string, AccessResult> = {}

Functions

checkAccess

checkAccess(uaId?: string, type?: AccessType, __namedParameters?: { autoReturn: undefined | boolean }): Promise<AccessResult>

- Defined in service/access.ts:120
检测权限并返回结果

export
Parameters
- uaId: string = config.uaId
- type: AccessType = config.accessType
- __namedParameters: { autoReturn: undefined | boolean } = {}
  - autoReturn: undefined | boolean
Returns Promise<AccessResult>

findLimit

findLimit(uaId?: string, type?: AccessType): Promise<Access["Limit"]> | null

- Defined in service/access.ts:54
查询微站权限配置

export
Parameters
- uaId: string = config.uaId
- type: AccessType = config.accessType
Returns Promise<Access["Limit"]> | null

getAccess

getAccess(uaId?: string, type?: AccessType): Access["AccessResponse"]

- Defined in service/access.ts:78
验证目标的权限

export
Parameters
- uaId: string = config.uaId
- type: AccessType = config.accessType
Returns Access["AccessResponse"]

verifyContact

verifyContact(contact: string): Promise<{ code: ReturnCode; redirect?: string }>

- Defined in service/access.ts:226
在直播后台配置验证手机/邮箱才可访问，根据提交的表单信息（手机邮箱）进行校验

export
Parameters
- contact: string
  
  表单提交手机号或者邮箱
Returns Promise<{ code: ReturnCode; redirect?: string }>

Generated using TypeDoc