Class PhoneOAuthClient<ReceiverType, OptionsType>

Type Parameters

• ReceiverType extends Receiver = HttpReceiver
• OptionsType extends CommonClientOptions<OAuth, ReceiverType> = PhoneOptions<ReceiverType>

Hierarchy

• ProductClient<
  OAuth,
  PhoneEndpoints,
  PhoneEventProcessor,
  OptionsType,
  ReceiverType,
  >
  • PhoneOAuthClient

Index

Constructors

constructor

• new PhoneOAuthClient<
  ReceiverType extends Receiver = HttpReceiver,
  OptionsType extends
  AuthOptions<OAuthToken> & object & (
  (object | WideInstallerOptions) & { disableReceiver?: boolean; logger?: Logger; logLevel?: LogLevel; }
  ) = PhoneOptions<ReceiverType>,
  >(
  options: ClientConstructorOptions<OAuth, OptionsType, ReceiverType>,
  ): PhoneOAuthClient<ReceiverType, OptionsType>

• Type Parameters

  • ReceiverType extends Receiver = HttpReceiver
  • OptionsType extends AuthOptions<OAuthToken> & object & (
    (object | WideInstallerOptions) & { disableReceiver?: boolean; logger?: Logger; logLevel?: LogLevel; }
    ) = PhoneOptions<ReceiverType>

  Parameters

  • options: ClientConstructorOptions<OAuth, OptionsType, ReceiverType>

  Returns PhoneOAuthClient<ReceiverType, OptionsType>

  Inherited from ProductClient<OAuth, 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
  : PhoneOAuthClient<ReceiverType, OptionsType>,
  ): Promise<ReturnType<ReceiverType["start"]>>

• Parameters

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

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

  Inherited from ProductClient.start