Options
All
  • Public
  • Public/Protected
  • All
Menu

Module service/access

Index

Enumerations

Interfaces

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

AccessType

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

checkAccess的type

Variables

Const AccessCodeText

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

AccessCode对应的文本描述

Const access

access: Record<string, AccessResult> = {}

Functions

checkAccess

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

  • 检测权限并返回结果

    export

    Parameters

    • uaId: string = config.uaId
    • type: AccessType = config.accessType
    • __namedParameters: { autoReturn: undefined | boolean } = {}
      • autoReturn: undefined | boolean

    Returns Promise<AccessResult>

findLimit

  • 查询微站权限配置

    export

    Parameters

    • uaId: string = config.uaId
    • type: AccessType = config.accessType

    Returns Promise<Access["Limit"]> | null

getAccess

  • 验证目标的权限

    export

    Parameters

    • uaId: string = config.uaId
    • type: AccessType = config.accessType

    Returns Access["AccessResponse"]

verifyContact

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

  • 在直播后台配置验证手机/邮箱才可访问，根据提交的表单信息（手机邮箱）进行校验

    export

    Parameters

    • contact: string

      表单提交手机号或者邮箱

    Returns Promise<{ code: ReturnCode; redirect?: string }>

Generated using TypeDoc