Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TwitterBot

Hierarchy

  • TwitterBot

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • new TwitterBot(__namedParameters: TwitterBotOptions): TwitterBot

Properties

agentId

agentId: string

client

client: default

engine

engine: default<TwitterChannel, TwitterSegmentValue, TwitterComponent<unknown, UnitSegment<TwitterSegmentValue>>, TwitterJob, TwitterApiResult>

platform

platform: "twitter" = TWITTER

Methods

fetchMediaFile

  • fetchMediaFile(url: string): Promise<{ content: ReadableStream; contentLength?: number; contentType?: string }>

makeApiCall

  • makeApiCall<Result>(method: string, href: string, parameters?: Record<string, unknown>, options?: { asApplication?: boolean }): Promise<Result>

  • Type parameters

    • Result

    Parameters

    • method: string
    • href: string
    • Optional parameters: Record<string, unknown>
    • Optional options: { asApplication?: boolean }
      • Optional asApplication?: boolean

    Returns Promise<Result>

render

renderDirectMeaasge

renderMedia

renderTweet

renderWelcomeMessage

  • renderWelcomeMessage(name: undefined | string, message: SociablyNode): Promise<null | { name: string; welcome_message: { created_timestamp: string; id: string; message_data: any } }>

  • Parameters

    Returns Promise<null | { name: string; welcome_message: { created_timestamp: string; id: string; message_data: any } }>

start

  • start(): Promise<void>

stop

  • stop(): Promise<void>

Generated using TypeDoc