ChatClient | @mlbd/chat-client

Hierarchy

ChatClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ChatClient(options: ChatClientOptions): ChatClient

- Defined in chat-client.ts:48
Parameters
- options: ChatClientOptions
Returns ChatClient

Properties

Private options

options: ChatClientOptions

Private pusherProvider

pusherProvider: PusherProvider

Private tokenProvider

tokenProvider: TokenProvider

Methods

addPinnedMessage

addPinnedMessage(messageId: string): Promise<any>

- Defined in chat-client.ts:244
Parameters
- messageId: string
Returns Promise<any>

addSavedMessage

addSavedMessage(messageId: string): Promise<any>

- Defined in chat-client.ts:283
Parameters
- messageId: string
Returns Promise<any>

connect

connect(): Promise<void>

- Defined in chat-client.ts:346
Returns Promise<void>

deleteMessage

deleteMessage(messageId: string): Promise<any>

- Defined in chat-client.ts:157
Parameters
- messageId: string
Returns Promise<any>

disconnect

disconnect(): Promise<void>

- Defined in chat-client.ts:351
Returns Promise<void>

getAttachmentDownloadUrl

getAttachmentDownloadUrl(attachmentId: string): Promise<string>

- Defined in chat-client.ts:339
Parameters
- attachmentId: string
Returns Promise<string>

getAttachmentFileDetail

getAttachmentFileDetail(attachmentId: string): Promise<IAttachmentFileDetail>

- Defined in chat-client.ts:330
Parameters
- attachmentId: string
Returns Promise<IAttachmentFileDetail>

Private getAttachmentUploadUrl

getAttachmentUploadUrl(fileName: string, mimeType: string): Promise<any>

- Defined in chat-client.ts:425
Parameters
- fileName: string
- mimeType: string
Returns Promise<any>

Private getFileWithProperType

getFileWithProperType(file: File): File

- Defined in chat-client.ts:417
Parameters
- file: File
Returns File

getGroup

getGroup(groupId: string): Promise<any>

- Defined in chat-client.ts:170
Parameters
- groupId: string
Returns Promise<any>

getGroupAttachments

getGroupAttachments(groupId: string, limit?: undefined | number, offset?: undefined | number): Promise<any>

- Defined in chat-client.ts:224
Parameters
- groupId: string
- Optional limit: undefined | number
- Optional offset: undefined | number
Returns Promise<any>

getGroupMessages

getGroupMessages(groupId: string, limit?: undefined | number, skipTillTime?: Date): Promise<any>

- Defined in chat-client.ts:94
Parameters
- groupId: string
- Optional limit: undefined | number
- Optional skipTillTime: Date
Returns Promise<any>

getGroupPinnedMessages

getGroupPinnedMessages(groupId: string): Promise<any>

- Defined in chat-client.ts:270
Parameters
- groupId: string
Returns Promise<any>

getGroupSavedMessages

getGroupSavedMessages(groupId: string): Promise<any>

- Defined in chat-client.ts:317
Parameters
- groupId: string
Returns Promise<any>

getMessage

getMessage(messageId: string): Promise<any>

- Defined in chat-client.ts:183
Parameters
- messageId: string
Returns Promise<any>

getMessageHistory

getMessageHistory(options: IMessageHistoryOptions): Promise<any>

- Defined in chat-client.ts:109
Parameters
- options: IMessageHistoryOptions
Returns Promise<any>

getMyGroups

getMyGroups(): Promise<any>

- Defined in chat-client.ts:61
Returns Promise<any>

getMyStats

getMyStats(): Promise<any>

- Defined in chat-client.ts:138
Returns Promise<any>

getSavedMessages

getSavedMessages(): Promise<any>

- Defined in chat-client.ts:309
Returns Promise<any>

markGroupAsRead

markGroupAsRead(markGroupAsReadOptions: IMarkGroupAsReadOptions): Promise<any>

- Defined in chat-client.ts:143
Parameters
- markGroupAsReadOptions: IMarkGroupAsReadOptions
Returns Promise<any>

onAddedToGroup

onAddedToGroup(cb: function): void

- Defined in chat-client.ts:359
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onGroupDeleted

onGroupDeleted(cb: function): void

- Defined in chat-client.ts:367
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onGroupMemberAdded

onGroupMemberAdded(cb: function): void

- Defined in chat-client.ts:371
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onGroupMemberRemoved

onGroupMemberRemoved(cb: function): void

- Defined in chat-client.ts:375
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onGroupUpdated

onGroupUpdated(cb: function): void

- Defined in chat-client.ts:363
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onMessageDeleted

onMessageDeleted(cb: function): void

- Defined in chat-client.ts:379
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onMessageRead

onMessageRead(cb: function): void

- Defined in chat-client.ts:383
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onMessageRecieved

onMessageRecieved(cb: function): void

- Defined in chat-client.ts:355
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onMessageUpdated

onMessageUpdated(cb: function): void

- Defined in chat-client.ts:387
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onPinnedMessageAdded

onPinnedMessageAdded(cb: function): void

- Defined in chat-client.ts:391
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onPinnedMessageRemoved

onPinnedMessageRemoved(cb: function): void

- Defined in chat-client.ts:395
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onSavedMessageAdded

onSavedMessageAdded(cb: function): void

- Defined in chat-client.ts:399
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onSavedMessageRemoved

onSavedMessageRemoved(cb: function): void

- Defined in chat-client.ts:403
Parameters
- cb: function
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

removePinnedMessage

removePinnedMessage(messageId: string): Promise<any>

- Defined in chat-client.ts:257
Parameters
- messageId: string
Returns Promise<any>

removeSavedMessage

removeSavedMessage(messageId: string): Promise<any>

- Defined in chat-client.ts:296
Parameters
- messageId: string
Returns Promise<any>

searchMessages

searchMessages(options: ISearchMessagesOptions): Promise<any>

- Defined in chat-client.ts:196
Parameters
- options: ISearchMessagesOptions
Returns Promise<any>

sendMessage

sendMessage(sendMessageOptions: ISendMessageOptions): Promise<any>

- Defined in chat-client.ts:66
Parameters
- sendMessageOptions: ISendMessageOptions
Returns Promise<any>

Private uploadAttachment

uploadAttachment(file: File): Promise<any>

- Defined in chat-client.ts:407
Parameters
- file: File
Returns Promise<any>

Generated using TypeDoc