Skip to main content

AttachmentService#

The AttachmentService manages the uploads of a message input.

Type parameters#

NameType
Textends DefaultStreamChatGenerics = DefaultStreamChatGenerics

Properties#

attachmentUploadInProgressCounter$#

attachmentUploadInProgressCounter$: Observable<number>

Emits the number of uploads in progress.

Defined in#

lib/attachment.service.ts:22


attachmentUploads$#

attachmentUploads$: Observable<AttachmentUpload<DefaultStreamChatGenerics>[]>

Emits the state of the uploads (AttachmentUpload[]), it adds a state (success, error or uploading) to each file the user selects for upload. It is used by the AttachmentPreviewList to display the attachment previews.

Defined in#

lib/attachment.service.ts:26

Methods#

addAttachment#

addAttachment(attachment): void

You can add custom image, video and file attachments using this method.

Note: If you just want to use your own CDN for file uploads, you don't necessary need this method, you can just specify you own upload function in the ChannelService

Parameters#

NameType
attachmentAttachment<T>

Returns#

void

Defined in#

lib/attachment.service.ts:103


createFromAttachments#

createFromAttachments(attachments): void

Maps attachments received from the Stream API to uploads. This is useful when editing a message.

Parameters#

NameTypeDescription
attachmentsAttachment<T>[]Attachemnts received with the message

Returns#

void

Defined in#

lib/attachment.service.ts:189


deleteAttachment#

deleteAttachment(upload): Promise<void>

Deletes an attachment, the attachment can have any state (error, uploading or success).

Parameters#

NameType
uploadAttachmentUpload<DefaultStreamChatGenerics>

Returns#

Promise<void>

Defined in#

lib/attachment.service.ts:128


filesSelected#

filesSelected(fileList): Promise<void>

Uploads the selected files, and creates preview for image files. The result is propagated throught the attachmentUploads$ stream.

Parameters#

NameTypeDescription
fileListnull | FileListThe files selected by the user

Returns#

Promise<void>

A promise with the result

Defined in#

lib/attachment.service.ts:54


mapToAttachments#

mapToAttachments(): Attachment<DefaultGenerics>[]

Maps the current uploads to a format that can be sent along with the message to the Stream API.

Returns#

Attachment<DefaultGenerics>[]

the attachments

Defined in#

lib/attachment.service.ts:158


resetAttachmentUploads#

resetAttachmentUploads(): void

Resets the attachments uploads (for example after the message with the attachments sent successfully)

Returns#

void

Defined in#

lib/attachment.service.ts:45


retryAttachmentUpload#

retryAttachmentUpload(file): Promise<void>

Retries to upload an attachment.

Parameters#

NameType
fileFile

Returns#

Promise<void>

A promise with the result

Defined in#

lib/attachment.service.ts:113

Did you find this page helpful?