Class TwitterAgentkit

Twitter Agentkit

Index

Constructors

Methods

run validateOptions

Constructors

constructor

new TwitterAgentkit(
    options?: {
        accessToken: string;
        accessTokenSecret: string;
        apiKey: string;
        apiSecret: string;
    },
): TwitterAgentkit
Initializes a new instance of TwitterAgentkit with the provided options. If no options are provided, it attempts to load the required environment variables.
Parameters
- Optionaloptions: {
      accessToken: string;
      accessTokenSecret: string;
      apiKey: string;
      apiSecret: string;
  }
  Optional. The configuration options for the TwitterAgentkit.
Returns TwitterAgentkit
Throws
An error if the provided options are invalid or if the environment variables cannot be loaded.
- Defined in cdp-agentkit-core/src/twitter_agentkit.ts:65

Methods

run

run<TActionSchema extends TwitterActionSchemaAny>(
action: TwitterAction<TActionSchema>,
args: TActionSchema,
): Promise<string>
Executes a Twitter (X) action.
Type Parameters
- TActionSchema extends TwitterActionSchemaAny
Parameters
- action: TwitterAction<TActionSchema>
  The Twitter (X) action to execute.
- args: TActionSchema
  The arguments for the action.
Returns Promise<string>
The result of the execution.
- Defined in cdp-agentkit-core/src/twitter_agentkit.ts:123

validateOptions

validateOptions(
    options: {
        accessToken: string;
        accessTokenSecret: string;
        apiKey: string;
        apiSecret: string;
    },
): boolean
Validates the provided options for the TwitterAgentkit.
Parameters
- options: {
      accessToken: string;
      accessTokenSecret: string;
      apiKey: string;
      apiSecret: string;
  }
  The options to validate.
Returns boolean
True if the options are valid, otherwise false.
- Defined in cdp-agentkit-core/src/twitter_agentkit.ts:102