NumberVerifier
Defined in: packages/channel/src/verification/number.verify.ts:149
Extends
Section titled “Extends”EventEmitter
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new NumberVerifier(
options?):NumberVerifier
Defined in: packages/channel/src/verification/number.verify.ts:173
Parameters
Section titled “Parameters”options?
Section titled “options?”Partial<NumberVerifierOptions> = {}
Returns
Section titled “Returns”NumberVerifier
Overrides
Section titled “Overrides”EventEmitter.constructor
Methods
Section titled “Methods”addListener()
Section titled “addListener()”addListener(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:16
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.addListener
blockPhoneNumber()
Section titled “blockPhoneNumber()”blockPhoneNumber(
phoneNumber,reason?):void
Defined in: packages/channel/src/verification/number.verify.ts:433
Block a phone number from verification
Parameters
Section titled “Parameters”phoneNumber
Section titled “phoneNumber”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”void
cancelVerification()
Section titled “cancelVerification()”cancelVerification(
requestId):Promise<boolean>
Defined in: packages/channel/src/verification/number.verify.ts:414
Cancel verification request
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
Returns
Section titled “Returns”Promise<boolean>
cleanup()
Section titled “cleanup()”cleanup():
number
Defined in: packages/channel/src/verification/number.verify.ts:511
Clean up expired verification requests
Returns
Section titled “Returns”number
emit()
Section titled “emit()”emit(
eventName, …args):boolean
Defined in: packages/channel/src/shared/event-emitter.ts:44
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
…any[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”EventEmitter.emit
eventNames()
Section titled “eventNames()”eventNames():
string[]
Defined in: packages/channel/src/shared/event-emitter.ts:71
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”EventEmitter.eventNames
getVerificationStats()
Section titled “getVerificationStats()”getVerificationStats():
object
Defined in: packages/channel/src/verification/number.verify.ts:462
Get verification statistics
Returns
Section titled “Returns”object
averageCompletionTime
Section titled “averageCompletionTime”averageCompletionTime:
number
byMethod
Section titled “byMethod”byMethod:
Record<string,number>
byStatus
Section titled “byStatus”byStatus:
Record<string,number>
successRate
Section titled “successRate”successRate:
number
total:
number
getVerificationStatus()
Section titled “getVerificationStatus()”getVerificationStatus(
requestId):PhoneVerificationRequest|null
Defined in: packages/channel/src/verification/number.verify.ts:407
Get verification request status
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
Returns
Section titled “Returns”PhoneVerificationRequest | null
listenerCount()
Section titled “listenerCount()”listenerCount(
eventName):number
Defined in: packages/channel/src/shared/event-emitter.ts:67
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”EventEmitter.listenerCount
off(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:20
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.off
on(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:9
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”once(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:35
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.once
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
eventName?):this
Defined in: packages/channel/src/shared/event-emitter.ts:57
Parameters
Section titled “Parameters”eventName?
Section titled “eventName?”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener(
eventName,listener):this
Defined in: packages/channel/src/shared/event-emitter.ts:31
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeListener
resendCode()
Section titled “resendCode()”resendCode(
requestId,method?):Promise<PhoneVerificationRequest>
Defined in: packages/channel/src/verification/number.verify.ts:357
Resend verification code
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
method?
Section titled “method?”Returns
Section titled “Returns”Promise<PhoneVerificationRequest>
startVerification()
Section titled “startVerification()”startVerification(
senderNumberId,phoneNumber,verificationType?,metadata?):Promise<PhoneVerificationRequest>
Defined in: packages/channel/src/verification/number.verify.ts:186
Start phone number verification process
Parameters
Section titled “Parameters”senderNumberId
Section titled “senderNumberId”string
phoneNumber
Section titled “phoneNumber”string
verificationType?
Section titled “verificationType?”VerificationType = VerificationType.SMS
metadata?
Section titled “metadata?”callProvider?
Section titled “callProvider?”string
deviceId?
Section titled “deviceId?”string
ipAddress?
Section titled “ipAddress?”string
smsProvider?
Section titled “smsProvider?”string
userAgent?
Section titled “userAgent?”string
Returns
Section titled “Returns”Promise<PhoneVerificationRequest>
unblockPhoneNumber()
Section titled “unblockPhoneNumber()”unblockPhoneNumber(
phoneNumber):void
Defined in: packages/channel/src/verification/number.verify.ts:453
Unblock a phone number
Parameters
Section titled “Parameters”phoneNumber
Section titled “phoneNumber”string
Returns
Section titled “Returns”void
verifyCode()
Section titled “verifyCode()”verifyCode(
requestId,providedCode):Promise<{message:string;status:PhoneVerificationStatus;success:boolean; }>
Defined in: packages/channel/src/verification/number.verify.ts:249
Verify the provided code
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
providedCode
Section titled “providedCode”string
Returns
Section titled “Returns”Promise<{ message: string; status: PhoneVerificationStatus; success: boolean; }>