Class Api

Hierarchy

EventEmitter
- Api

Implements

ApiEvents

Index

Constructors

constructor

Properties

Constructors

constructor

new Api(context: ApiContext, io: HttpIo): Api

- Defined in src/lib/api.ts:26
Parameters
- context: ApiContext
- io: HttpIo
Returns Api

Properties

context

context: ApiContext

io

messagesPoller

messagesPoller: MessagesPoller

Static defaultMaxListeners

defaultMaxListeners: number

Methods

acceptContactRequest

acceptContactRequest(contactUsername: string): Promise<this>

- Defined in src/lib/api.ts:38
Parameters
- contactUsername: string
Returns Promise<this>

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/index.d.ts:909
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

declineContactRequest

declineContactRequest(contactUsername: string): Promise<this>

- Defined in src/lib/api.ts:43
Parameters
- contactUsername: string
Returns Promise<this>

emit

emit(event: string | symbol, ...args: any[]): boolean

Implementation of ApiEvents.emit

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/index.d.ts:919
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Implementation of ApiEvents.eventNames

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in node_modules/@types/node/index.d.ts:920
Returns Array<string | symbol>

getContact

getContact(contactId: string): Promise<Contact>

- Defined in src/lib/api.ts:48
Parameters
- contactId: string
Returns Promise<Contact>

getContacts

getContacts(): Promise<Contact[]>

- Defined in src/lib/api.ts:52
Returns Promise<Contact[]>

getConversation

getConversation(conversationId: string): Promise<Conversation>

- Defined in src/lib/api.ts:56
Parameters
- conversationId: string
Returns Promise<Conversation>

getConversations

getConversations(): Promise<Conversation[]>

- Defined in src/lib/api.ts:60
Returns Promise<Conversation[]>

getMaxListeners

getMaxListeners(): number

Implementation of ApiEvents.getMaxListeners

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/index.d.ts:917
Returns number

getState

getState(): ApiContext.Json

- Defined in src/lib/api.ts:72
Returns ApiContext.Json

Protected handlePollingEvent

handlePollingEvent(ev: EventMessage): void

- Defined in src/lib/api.ts:96
Parameters
- ev: EventMessage
Returns void

listen

listen(): Promise<this>

- Defined in src/lib/api.ts:83
Start polling and emitting events

Returns Promise<this>

listenerCount

listenerCount(type: string | symbol): number

Implementation of ApiEvents.listenerCount

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/index.d.ts:921
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Implementation of ApiEvents.listeners

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in node_modules/@types/node/index.d.ts:918
Parameters
- event: string | symbol
Returns Function[]

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/index.d.ts:910
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/index.d.ts:911
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/index.d.ts:912
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/index.d.ts:913
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Implementation of ApiEvents.removeAllListeners

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/index.d.ts:915
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/index.d.ts:914
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

sendImage

sendImage(message: NewImage, conversationId: string): Promise<SendMessageResult>

- Defined in src/lib/api.ts:68
Parameters
- message: NewImage
- conversationId: string
Returns Promise<SendMessageResult>

sendMessage

sendMessage(message: NewMessage, conversationId: string): Promise<SendMessageResult>

- Defined in src/lib/api.ts:64
Parameters
- message: NewMessage
- conversationId: string
Returns Promise<SendMessageResult>

setMaxListeners

setMaxListeners(n: number): this

Implementation of ApiEvents.setMaxListeners

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/index.d.ts:916
Parameters
- n: number
Returns this

setStatus

setStatus(status: api.Status): Promise<void>

- Defined in src/lib/api.ts:76
Parameters
- status: api.Status
Returns Promise<void>

stopListening

stopListening(): Promise<this>

- Defined in src/lib/api.ts:91
Stop polling and emitting events

Returns Promise<this>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/index.d.ts:906
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc