Class ConversationRequestOptionsInternal

constructor

• new ConversationRequestOptions(pluginService, options?): ConversationRequestOptions

• Parameters

  • pluginService: ConversationPluginService<ConversationPlugin<string, any, any>[]>

  • options: {
        headers?: Record<string, string>;
        proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
    } = {}

    • Optional headers?: Record<string, string>

    • Optional proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; }

  Returns ConversationRequestOptions

headers

proxy

getRequestOptions

• getRequestOptions(): {
      headers: undefined | Record<string, string>;
      proxy: undefined | {
          auth?: { username: string; password: string; };
          host: string;
          port?: number;
          protocol?: "http" | "https";
      };
  }

• Returns the current request options.

  Returns {
      headers: undefined | Record<string, string>;
      proxy: undefined | {
          auth?: { username: string; password: string; };
          host: string;
          port?: number;
          protocol?: "http" | "https";
      };
  }

  • headers: undefined | Record<string, string>

  • proxy: undefined | {
        auth?: { username: string; password: string; };
        host: string;
        port?: number;
        protocol?: "http" | "https";
    }

setRequestOptions

• setRequestOptions(requestOptions, merge?): void

• Sets new request options to be used as defaults for all HTTP requests made by this conversation.

  Parameters

  • requestOptions: {
        headers?: Record<string, string>;
        proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
    }

    The new request options to use.

    • Optional headers?: Record<string, string>

    • Optional proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; }

  • merge: boolean = false

    Set to true to shallow merge the new request options with the existing request options instead of replacing them.

  Returns void

toJSON

• toJSON(): {
      headers?: Record<string, string>;
      proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
  }

• Serializes the ConversationRequestOptions to JSON.

  Returns {
      headers?: Record<string, string>;
      proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
  }

  A JSON representation of the ConversationRequestOptions instance.

  • Optional headers?: Record<string, string>

  • Optional proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; }