Botyo API Documentation

Index

Modules

Enumerations

Reaction

Classes

Interfaces

Type aliases

ChatThreadParticipantConsumer

ChatThreadParticipantConsumer: function

Type declaration

- (chatThreadId: FacebookId, participantVanityOrId: FacebookId, participantObj: ConfigurationParticipantObject, participantsObj: ConfigurationParticipantsObject): boolean | void | Promise<boolean | void>
- Parameters
  - chatThreadId: FacebookId
  - participantVanityOrId: FacebookId
  - participantObj: ConfigurationParticipantObject
  - participantsObj: ConfigurationParticipantsObject
  Returns boolean | void | Promise<boolean | void>

ConfigurationChatThreadObject

ConfigurationChatThreadObject: object

Type declaration

Optional name?: undefined | string
Optional overrides?: undefined | object
participants: ConfigurationParticipantsObject

ConfigurationChatThreadsObject

ConfigurationChatThreadsObject: object

Type declaration

[index: string]: ConfigurationChatThreadObject

ConfigurationParticipantObject

ConfigurationParticipantObject: object

Type declaration

[index: string]: any
Optional aliases?: string[]
firstName: string
id: FacebookId
Optional isAdmin?: undefined | true | false
name: string
Optional nickname?: undefined | string
Optional overrides?: undefined | object
Optional vanity?: undefined | string

ConfigurationParticipantsObject

ConfigurationParticipantsObject: object

Type declaration

[index: string]: ConfigurationParticipantObject

Constructor

Constructor: object

Type declaration

EndTypingIndicatorFunction

EndTypingIndicatorFunction: function

Ends the typing indicator.

callback: EndTypingIndicatorFunction
returns: empty promise

Type declaration

- (): Promise<void>
- Returns Promise<void>

FacebookId

FacebookId: string | number

Message

Message: object

Defines a message object.

see: https://github.com/Schmavery/facebook-chat-api/blob/master/DOCS.md#apilistencallback

Type declaration

[index: string]: any
attachments: any[]
body: string
isGroup: boolean
isUnread: boolean
mentions: any[]
messageID: string
senderID: string
threadID: FacebookId
type: string

MessageHandler

MessageHandler: function

Function that gets called upon receiving a message.

callback: MessageHandler
param: the message object

Type declaration

- (err: any, msg: Message): void
- Parameters
  - err: any
  - msg: Message
  Returns void

OutgoingMessage

OutgoingMessage: object

Defines an outgoing message.

Type declaration

Optional attachment?: ReadableStream | ReadableStream[] | Readable | Readable[]
Optional body?: undefined | string
Optional emoji?: undefined | string
Optional emojiSize?: "small" | "medium" | "large"
Optional mentions?: any[]
Optional sticker?: undefined | string
Optional url?: undefined | string

ServiceIdentifier

ServiceIdentifier: string | symbol | object | Abstract<T>

StopListeningFunction

StopListeningFunction: function

Function, returned by listen(), that when invoked makes the API stop listening for incoming messages and events

function

Type declaration

- (): void
- Returns void

UserInfoResult

UserInfoResult: object

Type declaration

[index: string]: UserInfoObject

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Type aliases

ChatThreadParticipantConsumer

Type declaration

Parameters

chatThreadId: FacebookId

participantVanityOrId: FacebookId

participantObj: ConfigurationParticipantObject

participantsObj: ConfigurationParticipantsObject

Returns boolean | void | Promise<boolean | void>

ConfigurationChatThreadObject

Type declaration

Optional name?: undefined | string

Optional overrides?: undefined | object

participants: ConfigurationParticipantsObject

ConfigurationChatThreadsObject

Type declaration

[index: string]: ConfigurationChatThreadObject

ConfigurationParticipantObject

Type declaration

[index: string]: any

Optional aliases?: string[]

firstName: string

id: FacebookId

Optional isAdmin?: undefined | true | false

name: string

Optional nickname?: undefined | string

Optional overrides?: undefined | object

Optional vanity?: undefined | string

ConfigurationParticipantsObject

Type declaration

[index: string]: ConfigurationParticipantObject

Constructor

Type declaration

EndTypingIndicatorFunction

Type declaration

Returns Promise<void>

FacebookId

Message

Type declaration

[index: string]: any

attachments: any[]

body: string

isGroup: boolean

isUnread: boolean

mentions: any[]

messageID: string

senderID: string

threadID: FacebookId

type: string

MessageHandler

Type declaration

Parameters

err: any

msg: Message

Returns void

OutgoingMessage

Type declaration

Optional attachment?: ReadableStream | ReadableStream[] | Readable | Readable[]

Optional body?: undefined | string

Optional emoji?: undefined | string

Optional emojiSize?: "small" | "medium" | "large"

Optional mentions?: any[]

Optional sticker?: undefined | string

Optional url?: undefined | string

ServiceIdentifier

StopListeningFunction

Type declaration

Returns void

UserInfoResult

Type declaration

[index: string]: UserInfoObject