Class PhoneS2SAuthClient<ReceiverType, OptionsType>

Type Parameters

• ReceiverType extends Receiver = HttpReceiver
• OptionsType extends CommonClientOptions<S2SAuth, ReceiverType> = PhoneS2SAuthOptions<ReceiverType>

Hierarchy

• ProductClient<
  S2SAuth,
  PhoneEndpoints,
  PhoneEventProcessor,
  OptionsType,
  ReceiverType,
  >
  • PhoneS2SAuthClient

Index

Constructors

constructor

• new PhoneS2SAuthClient<
  ReceiverType extends Receiver = HttpReceiver,
  OptionsType extends
  CommonClientOptions<S2SAuth, ReceiverType> = PhoneS2SAuthOptions<
  ReceiverType,
  >,
  >(
  options: ClientConstructorOptions<S2SAuth, OptionsType, ReceiverType>,
  ): PhoneS2SAuthClient<ReceiverType, OptionsType>

• Type Parameters

  • ReceiverType extends Receiver = HttpReceiver
  • OptionsType extends CommonClientOptions<S2SAuth, ReceiverType> = PhoneS2SAuthOptions<ReceiverType>

  Parameters

  • options: ClientConstructorOptions<S2SAuth, OptionsType, ReceiverType>

  Returns PhoneS2SAuthClient<ReceiverType, OptionsType>

  Inherited from ProductClient<S2SAuth, PhoneEndpoints, PhoneEventProcessor, OptionsType, ReceiverType>.constructor

Properties

Readonlyendpoints

Inherited from ProductClient.endpoints

ReadonlywebEventConsumer

Inherited from ProductClient.webEventConsumer

Methods

start

• start(
  this: IsReceiverDisabled<OptionsType> extends true
  ? never
  : PhoneS2SAuthClient<ReceiverType, OptionsType>,
  ): Promise<ReturnType<ReceiverType["start"]>>

• Parameters

  • this: IsReceiverDisabled<OptionsType> extends true
    ? never
    : PhoneS2SAuthClient<ReceiverType, OptionsType>

  Returns Promise<ReturnType<ReceiverType["start"]>>

  Inherited from ProductClient.start